Update a contact
PATCH
/v1/contacts/{contact_id}
curl -X PATCH "https://us1.platform.bird.com/v1/contacts/{contact_id}" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"first_name": "Alice",
"last_name": "Anderson"
}'Updates a contact. Supplied fields are changed; omitted fields are left unchanged. Custom values in data are merged — keys you supply are set, keys set to null are removed, and keys you omit are unchanged. Changing the email address or external_id to a value already used by another contact returns a conflict error.
पैरामीटर
contact_id
string
Contact ID.
Request Payload
email
string
New email address for the contact. Trimmed and lowercased before it is stored and checked for uniqueness. Must not be in use by another contact in the workspace.
first_name
nullable string
The contact's first name. Set to null to clear.
last_name
nullable string
The contact's last name. Set to null to clear.
external_id
nullable string
Your own identifier for this contact. Unique within the workspace when set. Set to null to clear.
data
object
Custom property values to change, merged into the contact's existing data. Keys you supply are set, keys set to null are removed, and keys you omit are left unchanged. Each key must be a property created via the contact properties API, and each value must be a string, number, or boolean matching the property's declared type (strings up to 500 characters). The merged result is capped at 2 KB serialized.
Response Payload
id
string
आवश्यक
Contact ID.
email
string
आवश्यक
The contact's email address, stored trimmed and lowercased. Unique within the workspace.
first_name
nullable string
The contact's first name.
last_name
nullable string
The contact's last name.
external_id
nullable string
Your own identifier for this contact, such as a user ID in your system. Unique within the workspace when set.
data
object
Custom property values for this contact, available as template variables in broadcasts. Each key is a property created via the contact properties API, and each value is a string, number, or boolean matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized.
created_at
string
आवश्यक
updated_at
string
आवश्यक