Skip to main content
PATCH
Update a contact

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Path Parameters

contact
string
required

Contact uuid.

Body

application/json
username
string
Maximum string length: 128
email
string<email>
external_id
string
Maximum string length: 128
preferred_language
string
Maximum string length: 16
timezone
string
attributes
object

Merged into the stored attributes: keys you send are set, a key set to null is removed, and other keys are kept. Send "attributes": null to clear them all.

Response

Updated.

uuid
string
phone_number
string | null
bsuid
string | null

Business-scoped user id, when Meta gives one.

external_id
string | null
crm_id
string | null
identifiers
object[]
username
string | null
email
string | null
preferred_language
string | null
timezone
string | null
attributes
object
created_at
string<date-time> | null
updated_at
string<date-time> | null
identity
object