Sign in

v1

latestOpenAPI 3.0.42026-07-246086174.5 KB
Contacts

Add a new contact

post/api/ext/v3/contacts

Request body

whatsapp_numberstring required

The WhatsApp number of the contact to be added.

namestring required

The name of the contact.

Response

Returns the created contact.

idstring nullable

Unique identifier for the contact.

wa_idstring nullable

WhatsApp identifier for the contact.

namestring nullable

The contact's name.

phonestring nullable

The contact's phone number.

photostring nullable

URL or path to the contact's photo.

createdstring date-time

The date and time when the contact was created.

last_updatedstring date-time

The date and time when the contact was last updated.

contact_statusstring nullable

The current status of the contact.

sourcestring nullable

The source where the contact originated from.

channel_idstring nullable

The identifier of the channel associated with the contact.

ig_phone_sourcestring nullable

Instagram phone source information.

mg_phone_sourcestring nullable

Messenger phone source information.

opted_inboolean

Indicates whether the contact has opted in for communications.

allow_broadcastboolean

Indicates whether the contact allows broadcast messages.

allow_smsboolean

Indicates whether the contact allows SMS messages.

teamsstring[] nullable

List of team associated with the contact.

segmentsstring[] nullable

List of segments the contact belongs to.

channel_typestring nullable

The type of channel (e.g., whatsapp, instagram, messenger).

display_namestring nullable

The display name for the contact.

is_broadcast_limit_reachedstring nullable

Indicates whether the broadcast limit has been reached for this contact.