Add a contact to the list by phone number

Use this when you hold a phone number rather than a contact id. The number is normalized to canonical E.164 and matched against your contacts: the contact it finds is updated, and when there is none a contact is created — either way it ends up in this list, in one call. Omitted fields keep their stored value; attributes, when present, replaces the whole map. Repeating the call for the same number does not add a second membership.

To add a contact you already have the id of, without touching its fields, use PUT /contact-lists/{list_id}/contacts/{contact_id} instead.

Path Params
uuid
required

Identifier of the contact list to add the contact to.

Body Params

Contact to create or update, matched on its normalized phone number.

string
length between 1 and 255
.*\S.*

Display name; non-blank when present. Omit to keep the stored name.

string
required

Brazilian mobile number. Common formats are accepted (parentheses, dashes, spaces, with or without +55) and normalized to canonical E.164 (+55 + DDD + 9-digit subscriber).

attributes
object

Free-form string attributes; replaces the whole stored map when present, omit to keep it. Keys must start with a letter or underscore, continue with letters, digits or underscores, and may not be name or phone; keys and values are capped at 255 characters.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json