Archive a contact property
POST
/v1/contact-properties/{property_id}/archive
curl -X POST "https://us1.platform.bird.com/v1/contact-properties/{property_id}/archive" \
-H "Authorization: Bearer $TOKEN"Archives a contact property. The key stops being accepted in new contact writes and stops rendering in templates, but every value already stored on your contacts is preserved and still returned when you read a contact. The key stays reserved, so it cannot be re-created with a different type. Returns 409 if the property is already archived. Reverse it with unarchive.
Parameters
property_id
string
Contact property ID.
Response Payload
id
string
verplicht
Contact property ID.
key
string
verplicht
The property key, used as the key in contact data and as the template variable name in broadcasts. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.
type
string
verplicht
The value type every contact must use for this property. Cannot be changed after creation.
fallback_value
Default used when a contact has no value for this property and the template does not supply an inline fallback. A string, number, or boolean matching the declared type (strings up to 500 characters), or null when no fallback is set.
archived
boolean
Whether the property is archived. An archived property is rejected in new contact writes and stops rendering in templates, but every value already stored on contacts is preserved. Reactivate it with unarchive.
created_at
string
verplicht
updated_at
string
verplicht