Channels
get
channels.get
Read one channel with its type, name and the inbox it belongs to
Risk: read
list
channels.list
List the channels in the workspace, optionally only those in one inbox; a channel id is what a message is sent from
Risk: read
results full type
results full type
pagination full type
pagination full type
Contact Lists
addContact
contactLists.addContact
Add a contact to a contact list. The list is named in the body on this route, not in the path
Risk: write
{ id }, not in the path, on this route. Removing a contact takes it in the path instead.
Output
create
contactLists.create
Create a contact list that contacts can be added to
Risk: write
delete
contactLists.delete
Delete a contact list. Its membership goes with it, and this cannot be undone
Risk: destructive · Irreversible
forContact
contactLists.forContact
List the contact lists one contact belongs to, paged by cursor like the other lists
Risk: read
results full type
results full type
pagination full type
pagination full type
list
contactLists.list
List the contact lists in the workspace
Risk: read
results full type
results full type
pagination full type
pagination full type
removeContact
contactLists.removeContact
Remove a contact from a contact list; the contact itself stays
Risk: write
Contacts
create
contacts.create
Create a contact. At least one handle is required, and a handle is the email address or phone number that identifies them on a channel
Risk: write
custom_attributes full type
custom_attributes full type
handles full type
handles full type
handles full type
handles full type
custom_attributes full type
custom_attributes full type
delete
contacts.delete
Delete a contact and their handles. Conversations that referenced them lose the link, and this cannot be undone
Risk: destructive · Irreversible
get
contacts.get
Read one contact with their handles, gender and custom attribute values
Risk: read
handles full type
handles full type
custom_attributes full type
custom_attributes full type
list
contacts.list
List contacts newest first, paging with a cursor id; set after or before, never both
Risk: read
results full type
results full type
pagination full type
pagination full type
search
contacts.search
Search contacts by email, phone, Instagram or WhatsApp username, or a custom attribute; every expression has to match
Risk: read
query full type
query full type
results full type
results full type
pagination full type
pagination full type
update
contacts.update
Change a contact’s names, gender, handles or custom attributes. The route requires first name, last name and gender, so all three are sent back
Risk: write
handles full type
handles full type
custom_attributes full type
custom_attributes full type
handles full type
handles full type
custom_attributes full type
custom_attributes full type
Conversations
get
conversations.get
Read one conversation with its labels, assignees, linked contacts and snooze state
Risk: read
channel full type
channel full type
inbox full type
inbox full type
time_window full type
time_window full type
list
conversations.list
List conversations with their status, channel, inbox and assigned users, paging with a cursor id
Risk: read
results full type
results full type
pagination full type
pagination full type
messages
conversations.messages
List the messages in one conversation, paging with a cursor id
Risk: read
results full type
results full type
pagination full type
pagination full type
update
conversations.update
Change a conversation’s status, inbox, labels or assignees. Snoozing needs both a status of snoozed and a snoozed_until time
Risk: write
channel full type
channel full type
inbox full type
inbox full type
time_window full type
time_window full type
Inboxes
get
inboxes.get
Read one inbox with its name and workspace url
Risk: read
list
inboxes.list
List the inboxes in the workspace
Risk: read
results full type
results full type
pagination full type
pagination full type
Messages
get
messages.get
Read one message with its content, direction and status
Risk: read
content full type
content full type
to full type
to full type
send
messages.send
Send a text message on a channel to one recipient. This reaches a real person on WhatsApp, SMS or another channel, and the content has to suit that channel
Risk: destructive
to full type
to full type
from full type
from full type
content full type
content full type
content full type
content full type
to full type
to full type