Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Path Parameters

contactId
string
required

ID of the contact. List contacts with GET /api/v1/contacts to find it.

Example:

"cmbxgy7kq0002ph01u2v3w4x5"

Body

application/json
name
string

New display name.

Maximum string length: 120
Example:

"Sara Al-Harbi"

customFields
object

Keys to merge into the contact's custom fields (max 50 per request). Values may be strings (max 500 chars), numbers, booleans, or null to remove the key.

Example:

Response

The updated contact profile

contact
object
flows
object[]
notes
object[]