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_key is merged with the existing values: only the keys you send change. Send a key with null to clear it. custom_fields_by_name and custom_fields_meta_data are rebuilt automatically.
  • Changing any *_blacklist field (Do Not Disturb) sets dnd_updated_at to now and dnd_source to manual unless you send them.
  • phone is 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.