Skip to main content
PATCH
Update a contact
Only the fields you send change; omitted fields keep their values.

External IDs

  • external_id: send a string to set or replace the contact’s ID in your system, or null to clear it. Once a contact has an external_id, it is matched by that ID alone: channels that identify people by email or phone, such as inbound email, no longer match it and create their own contacts instead.
  • primary_external_id: send a string to link the contact to a main account, or null to unlink it. The main contact does not need to exist yet. See Link accounts to a main contact.
Both values are trimmed and must contain 1–255 characters.

Errors

  • 409: the update would give the contact an external_id another contact in your organization already has. Email only has to be unique among contacts without an external_id, so for a contact that has none after the update (including one whose external_id you clear) it also returns 409 when another such contact has the same email. Nothing is saved.
  • 400: the contact’s primary_external_id would equal its own external_id, counting values already saved. Nothing is saved.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contact_id
string
required

Body

application/json
contact
object
required

Response

Default Response