Contacts

Get Contact

get

Get a contact by phone number or email

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
phoneNumberstringOptional

Contact's phone number (must include valid country code)

Example: +1234567890
emailstring ยท emailOptional

Contact's email address

Example: [email protected]
Responses
chevron-right
200

Contact found

application/json
get
/contacts

Create New Contact

post

Create a new contact with phone number and optional information

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
phoneNumberstringRequired

Contact's phone number (must include valid country code)

firstNamestringOptional

Contact's first name

Default: Unknown
lastNamestringOptional

Contact's last name

Default: Unknown
emailstring ยท emailOptional

Contact's email address

Default: [email protected]
instagramIdstring | nullableOptional

Contact's Instagram ID

currentCampaignstring | nullableOptional

Current campaign identifier

currentCampaignDataobject | nullableOptional

Data associated with current campaign

channelstring | nullableOptional

Communication channel

isChatWindowOpenbooleanOptional

Whether chat window is open

Default: false
externalIdstring | nullableOptional

External identifier

customChannelstring | nullableOptional

Custom channel identifier

chatWidgetIdstring | nullableOptional

Chat widget identifier

is_bot_activebooleanOptional

Whether the bot is active for this contact

Default: true
do_not_disturbbooleanOptional

Whether the contact should not be disturbed

Default: false
Responses
chevron-right
200

Contact created successfully

application/json
post
/contacts

Update Contact

put

Update an existing contact's information

Authorizations
apiKeystringRequired
Path parameters
contactIdstringRequired

ID of the contact to update

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
firstNamestringOptional

Contact's first name

lastNamestringOptional

Contact's last name

emailstring ยท emailOptional

Contact's email address

is_bot_activebooleanOptional

Whether the bot is active for this contact

do_not_disturbbooleanOptional

Whether the contact should not be disturbed

Responses
chevron-right
200

Contact updated successfully

application/json
put
/contacts/{contactId}

Add Contact To List

post

Add a specific contact to a list

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
contactIdstringRequired

ID of the contact to add to the list

listIdstringRequired

ID of the list to add the contact to

Responses
chevron-right
200

Contact added to list successfully

application/json
post
/contacts/lists

Remove Contact From List

delete

Remove a specific contact from a list

Authorizations
apiKeystringRequired
Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Body
contactIdstringRequired

ID of the contact to remove from the list

listIdstringRequired

ID of the list to remove the contact from

Responses
chevron-right
200

Contact removed from list successfully

application/json
delete
/contacts/lists

Get Contact Tags

get

Get all tags associated with a contact

Authorizations
apiKeystringRequired
Path parameters
contactIdstringRequired

ID of the contact to get tags for

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Responses
chevron-right
200

List of contact tags

application/json
get
/contacts/tags/{contactId}

Get Contact Messages

get

Retrieve messages for a specific contact

Authorizations
apiKeystringRequired
Path parameters
contactIdstringRequired

ID of the contact to get messages for

Query parameters
apiKeystringOptional

API key for authentication

Example: your_api_key
Responses
chevron-right
200

List of messages

application/json
get
/contacts/messages/{contactId}

Last updated

Was this helpful?