Update a contact property
PATCH
/v1/contact-properties/{property_id}
await bird.contactProperties.update("cp_01krdgeqcxet5s7t44vh8rt9mg", { fallback_value: "free" });prop = client.contact_properties.update("prp_01krdgeqcxet5s7t44vh8rt9mg", fallback_value="free")
print(prop.fallback_value)property, err := client.ContactProperties.Update(context.Background(), "prp_123", bird.ContactPropertyUpdateParams{
FallbackValue: "free",
})
if err != nil {
log.Fatal(err)
}
fmt.Println(property.Id)$bird->contactProperties->update(
'cp_01krdgeqcxet5s7t44vh8rt9mg',
(new ContactPropertyUpdateRequest())->setFallbackValue('free'),
);bird contact-properties update <property-id> --body-file - <<'JSON'
{
"fallback_value": "free"
}
JSONcurl -X PATCH "https://us1.platform.bird.com/v1/contact-properties/{property_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"fallback_value": "free"
}'Odpowiedź200
{
"id": "prp_01krdgeqcxet5s7t44vh8rt9mg",
"type": "string",
"created_at": "2026-05-20T09:14:52Z",
"updated_at": "2026-05-25T16:42:01Z"
}
Updates a contact property's fallback value, the only mutable field. The key and type cannot be changed after creation; create a new property instead.
Parametry
property_id
string
ID of the contact property to update.
Treść żądania
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); a value of another type returns a validation error. Set to null to remove the fallback.
Treść odpowiedzi
id
string
wymagane
ID of the property, accepted by every operation that takes a property_id.
key
string
wymagane
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
wymagane
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
wymagane
updated_at
string
wymagane
Powiązane zasoby
Kontynuuj z dokumentacją, przewodnikami i przykładami dotyczącymi tego tematu. Zasoby są w języku angielskim.
Obejrzyj przewodnikManage your customers: contacts & audiencesPoznaj możliwościContacts and audiencesPodążaj ścieżką naukiBuild your first integrationPrzewodnik wdrożeniowyAudiences
Uzyskaj brief wdrożeniowy