Skip to main content
PATCH
Update contact

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

contact_id
string
required

Contact ID

Body

Schema for updating a contact

name
string | null

New display name.

Maximum string length: 512
blocked
boolean

Whether the contact is blocked.

unsubscribed
boolean

Whether the contact is unsubscribed.

ai_replies
boolean

Whether the assistant auto-replies to this contact (false stops auto-replies).

Response

200 - application/json

Schema for the contact

id
string
required
name
string | null
required
blocked
boolean
required
unsubscribed
boolean
required
ai_replies
boolean
required
is_admin
boolean
required
channels
object[]
required
segments
object[]
required
fields
object
required

Map of contact field key → value.

properties
object
required
deprecated

Deprecated: use fields. Same map, kept for compatibility.

created_at
string<date-time>
required
updated_at
string<date-time>
required
blocked_at
string<date-time>
unsubscribed_at
string<date-time>
unsubscribe_reason
string
unsubscribe_feedback
string
ai_replies_at
string<date-time>