Archive a contact property
/v1/contact-properties/{property_id}/archiveconst prop = await bird.contactProperties.archive("cp_01krdgeqcxet5s7t44vh8rt9mg");
console.log(prop.key, prop.archived);prop = client.contact_properties.archive("prp_01krdgeqcxet5s7t44vh8rt9mg")
print(prop.key, prop.archived)property, err := client.ContactProperties.Archive(context.Background(), "prp_123")
if err != nil {
log.Fatal(err)
}
fmt.Println(property.Archived)$property = $bird->contactProperties->archive('cp_01krdgeqcxet5s7t44vh8rt9mg');
echo $property->getKey(), ' ', var_export($property->getArchived(), true);bird contact-properties archive <property-id> --yescurl -X POST "https://us1.platform.bird.com/v1/contact-properties/{property_id}/archive" \
-H "Authorization: Bearer $TOKEN"{
"id": "prp_01krdgeqcxet5s7t44vh8rt9mg",
"key": "plan",
"type": "string",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
Archiving is how you remove a contact property. Bird keeps its values so you can restore it with Unarchive.
The property disappears from property pickers, including import column mapping. New template versions that read it cannot be published. The publish error names the property. Templates already published keep sending and fill in its value. You can still read and update the property's values through the API and imports. Values must match the property's type. See Archiving a property for more details.
Archiving returns a 409 conflict while a published automation, including a paused one, uses the property in a trigger or contact write. An active run that writes the property also blocks archiving. Remove the property from those automations or archive them. Let active runs finish or cancel them, then archive the property again. If you have permission to read automations, the error names up to five that use the property.
The key stays reserved and counts toward the workspace's 200-property limit. Archiving an already archived property also returns a 409 conflict. Use Unarchive a contact property to restore it.
Paramètres
property_idstringID of the contact property to archive.
Contenu de la réponse
idID of the property, accepted by every operation that takes a property_id.
keyThe 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.
typeThe 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_valueDefault 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.
archivedWhether 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_atupdated_atRessources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.