Skip to main content
PATCH
Update contact

Authorizations

Authorization
string
header
required

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

Path Parameters

contactId
string
required

Body

application/json
defaultChannel
enum<string> | null

Preferred channel for this contact. Set to null to clear.

Available options:
sms,
whatsapp,
telegram,
email,
instagram,
messenger,
voice
metadata
object

Response

Contact updated.

id
string
required
availableChannels
string[]
required

List of available messaging channels for this contact.

verified
boolean
required

Whether this contact has been verified.

metadata
object
required
createdAt
string<date-time>
required
displayName
string

Display name for the contact.

Example:

"John Doe"

phoneNumber
string

DEPRECATED: Use primaryPhone instead. Primary phone number in E.164 format.

Example:

"+56912345678"

primaryPhone
string

Primary phone number in E.164 format.

Example:

"+56912345678"

primaryEmail
string<email>

Primary email address.

Example:

"john@example.com"

countryCode
string
Example:

"CL"

profileName
string | null

Contact's WhatsApp profile name. Only available for WhatsApp contacts.

Example:

"John Doe"

defaultChannel
enum<string>

Preferred channel for this contact.

Available options:
sms,
whatsapp,
telegram,
email,
instagram,
messenger,
voice
channels
object[]

All communication channels for this contact.

suggestedMergeWith
string

ID of a contact suggested for merging.

updatedAt
string<date-time>