Archive a contact property
POST
/v1/contact-properties/{property_id}/archive
const 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"Respuesta200
{
"id": "prp_01krdgeqcxet5s7t44vh8rt9mg",
"type": "string",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
Archives a contact property. The key stops being accepted in contact writes, but every value already stored on your contacts is preserved and still returned when you read a contact.
Archiving a live property succeeds whatever else reads the key. From then on the property behaves as though it does not exist for new work: it is gone from the property pickers, and publishing a template version whose content reads bird.contact.<key> is refused, naming the property. Template versions published before you archived it are untouched and keep sending, filling the key from the values your contacts already carry.
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.
Parámetros
property_id
string
ID of the contact property to archive.
Carga de respuesta
id
string
obligatorio
ID of the property, accepted by every operation that takes a property_id.
key
string
obligatorio
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
obligatorio
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 keys are rejected in new contact writes and when publishing a new template version. Stored contact values are preserved, and previously published versions keep rendering them. Unarchive the property to use its key in new writes and template versions.
created_at
string
obligatorio
updated_at
string
obligatorio
Recursos relacionados
Continúa con la documentación, guías y ejemplos sobre este tema. Los recursos están en inglés.
Ver la guíaManage your customers: contacts & audiencesExplorar la funcionalidadContacts and audiencesSeguir la ruta de aprendizajeBuild your first integrationGuía de implementaciónAudiences
Obtener un resumen de implementación