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 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 and still counts toward the workspace's 200-property limit, so it cannot be re-created with a different type. Archiving an already-archived property returns a conflict error; reverse it with Unarchive a contact property.
Parameters
property_id
string
ID of the contact property to archive (prp_-prefixed).
Response Payload
id
string
required
ID of the property (prp_-prefixed), accepted by every operation that takes a property_id.
key
string
required
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
required
The value type every contact must use for this property. Cannot be changed after creation.
Possible values: string, number, boolean
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
required
updated_at
string
required