Sign inGet Started

Unarchive a contact property

POST
/v1/contact-properties/{property_id}/unarchive
await bird.contactProperties.unarchive("cp_01krdgeqcxet5s7t44vh8rt9mg");
Réponse200
{
  "id": "prp_01krdgeqcxet5s7t44vh8rt9mg",
  "key": "plan",
  "type": "string",
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Restores an archived contact property with its stored values. It appears in property pickers again and can be used in new template versions. Unarchiving a property that is not archived returns a 409 conflict.

Paramètres

property_idstring

ID of the contact property to unarchive.

Contenu de la réponse

id
string
obligatoire

ID of the property, accepted by every operation that takes a property_id.

key
string
obligatoire

The property key, used as the key in contact data and as the attribute in the bird.contact.<key> broadcast template variable. Lowercase letters, digits, and underscores, starting with a letter. Cannot be changed after creation.

type
string
obligatoire

The value type every contact must use for a property. Cannot be changed after creation.

datetime values are RFC 3339 timestamps with an explicit offset. Examples include 2024-01-15T09:30:00Z and 2024-01-15T11:30:00+02:00. A bare date or a time with no offset is rejected. The value is normalized to UTC with second precision on write, so 2024-01-15T11:30:00+02:00 is stored and returned as 2024-01-15T09:30:00Z, and any fractional seconds are dropped.

Possible values: string, number, boolean, datetime

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, boolean, or RFC 3339 datetime matching the declared type (strings up to 500 characters), or null when no fallback is set.

archived
boolean

Whether the property is archived. Archived properties disappear from pickers and cannot be used in new template versions. Published templates keep sending. Stored values remain available to read and update. Unarchive the property to restore it.

created_at
string
obligatoire
updated_at
string
obligatoire

Poursuivez avec la documentation, les guides et les exemples sur ce sujet.