Skip to main content
PATCH
Update contact

Path Parameters

tenantID
string<uuid>
required

The tenant the contact belongs to.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
contactID
string<uuid>
required

The contact to edit.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
addTags
string[]

Tags to add (kept as typed; existing ones are ignored).

Maximum array length: 50
Required string length: 1 - 60
contactBlock
boolean

Blocked contacts cannot start new conversations.

contactEmail

Email, stored lowercase; an empty string clears it.

Available options:
contactEmailVerified
boolean

Whether the email was confirmed by an operator.

contactFirstname
string

First name. Cannot be emptied.

Required string length: 1 - 120
contactLastname
string

Last name; an empty string clears it.

Maximum string length: 120
contactNameVerified
boolean

Whether the name was confirmed by an operator.

contactPhone
string

Phone; stored canonical (digits-only E.164). Numbers outside Brazil need the +country code. An empty string clears it. Does not change the WhatsApp address.

Maximum string length: 40
contactPhoneVerified
boolean

Whether the phone was confirmed by an operator.

removeTags
string[]

Tags to remove.

Maximum array length: 50
Required string length: 1 - 60

Response

Response for status 200.

contact
object
required

The contact as stored after the change.