Update a contact
Partially updates a contact. Only the fields you send change.
Endpoint
PATCH/contacts/:id
Body
Any writable field of the contact object. Unknown fields are rejected.
custom_fields_by_keyis merged with the existing values: only the keys you send change. Send a key withnullto clear it.custom_fields_by_nameandcustom_fields_meta_dataare rebuilt automatically.- Changing any
*_blacklistfield (Do Not Disturb) setsdnd_updated_atto now anddnd_sourcetomanualunless you send them. phoneis normalized the same way as on create.
Request
Response
Returns the updated contact object.
json
The response contains the full contact; it is shortened here. Updating a contact triggers the organization's "contact updated" automations and refreshes the contact data shown on its conversations.
Report an issue with this documentation
Please log in to report issues with our documentation.