Update a contact
PATCH
/v1/contacts/{contact_id}
const contact = await bird.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", {
first_name: "Jane",
});
console.log(contact.first_name);contact = client.contacts.update("con_01krdgeqcxet5s7t44vh8rt9mg", first_name="Jane")
print(contact.first_name)// Set the first name and clear the last name (Null sends an explicit JSON
// null); omit a field to leave it unchanged.
contact, err := client.Contacts.Update(context.Background(), "con_123", bird.ContactUpdateParams{
FirstName: bird.Value("Jane"),
LastName: bird.Null[string](),
})
if err != nil {
log.Fatal(err)
}
fmt.Println(contact.Id)$contact = $bird->contacts->update(
'con_01krdgeqcxet5s7t44vh8rt9mg',
(new ContactUpdateRequest())->setFirstName('Jane'),
);
echo $contact->getFirstName();bird contacts update <contact-id> \
--first-name Alice \
--last-name Andersoncurl -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 and omitted fields are left unchanged; set first_name, last_name, or external_id to null to clear them. 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, phone number, or external_id to a value already used by another contact returns a conflict error, and a contact always keeps at least one identifier: clearing both email and phone in the same contact is rejected.
Parametri
contact_id
string
ID of the contact to update (con_-prefixed).
Payload della richiesta
email
nullable 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. Omit to keep the current address; set to null to remove it, as long as the contact keeps at least one identifier.
phone_number
nullable string
New phone number for the contact, in E.164 format with the leading + and country code. Spaces and punctuation are accepted and stripped. Stored in its canonical form, which may differ from what you send, and unique within the workspace. Omit to keep the current number; set to null to remove it, as long as the contact keeps at least one identifier. An empty string behaves as null.
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, boolean, or RFC 3339 datetime matching the property's declared type (strings up to 500 characters); writing an unregistered or archived key returns a validation error. The merged result is capped at 2 KB serialized.
Payload di risposta
id
string
obbligatorio
ID of the contact (con_-prefixed), accepted by every operation that takes a contact_id.
email
nullable string
obbligatorio
The contact's email address, in its stored form, trimmed and lowercased before uniqueness is checked. Unique within the workspace. Null when the contact has no email address.
phone_number
nullable string
obbligatorio
The contact's phone number in normalized international form (a leading + and four to 15 digits), which may differ from the form it was supplied in. Bird normalizes formatting but does not verify the number against numbering-plan metadata. Unique within the workspace. Carriers recycle disconnected numbers, so a long-stored number can come to belong to someone else; external_id is the durable key for your own records. Null when the contact has no phone number.
first_name
nullable string
The contact's first name. Available in broadcast templates as bird.contact.first_name.
last_name
nullable string
The contact's last name. Available in broadcast templates as bird.contact.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 in broadcast templates as bird.contact.<key>. Each key is a property created via the contact properties API, and each value is a string, number, boolean, or RFC 3339 datetime matching the property's declared type (strings up to 500 characters). Total size is capped at 2 KB serialized. Values stored under a property that was later archived remain readable here.
audiences
array of object
The audiences this contact belongs to, most-recently-joined first. Only present when listing contacts; omitted from every other contact operation.
Mostra attributi secondari
audiences.id
string
obbligatorio
ID of the referenced audience (adn_-prefixed).
audiences.name
string
obbligatorio
The audience's display name.
created_at
string
obbligatorio
updated_at
string
obbligatorio