Skip to main content
New to Corsair? See API access, authentication, and error handling.

Channels

get

channels.get Read one channel with its type, name and the inbox it belongs to Risk: read
Input Output

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
Input Output

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
Input The list id goes in the body as { 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
Input Output

delete

contactLists.delete Delete a contact list. Its membership goes with it, and this cannot be undone Risk: destructive · Irreversible
Input Output

forContact

contactLists.forContact List the contact lists one contact belongs to, paged by cursor like the other lists Risk: read
Input Output

list

contactLists.list List the contact lists in the workspace Risk: read
Input Output

removeContact

contactLists.removeContact Remove a contact from a contact list; the contact itself stays Risk: write
Input Output

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
Input At least one handle is required; a handle is the email address or phone number that identifies the contact on a channel.
Output

delete

contacts.delete Delete a contact and their handles. Conversations that referenced them lose the link, and this cannot be undone Risk: destructive · Irreversible
Input Output

get

contacts.get Read one contact with their handles, gender and custom attribute values Risk: read
Input Output

list

contacts.list List contacts newest first, paging with a cursor id; set after or before, never both Risk: read
Input Paging is by cursor: set after or before, never both, and limit is 1 to 100 with a default of 50. Output

contacts.search Search contacts by email, phone, Instagram or WhatsApp username, or a custom attribute; every expression has to match Risk: read
Input Every expression has to match. A custom_attribute expression also needs an identifier; the schema rejects one without it.
Output

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
Input The route requires first_name, last_name and gender even though it is a PATCH. Their values may be null, but the keys must be present.
Output

Conversations

get

conversations.get Read one conversation with its labels, assignees, linked contacts and snooze state Risk: read
Input Output

list

conversations.list List conversations with their status, channel, inbox and assigned users, paging with a cursor id Risk: read
Input Output

messages

conversations.messages List the messages in one conversation, paging with a cursor id Risk: read
Input Output

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
Input Snoozing needs both status snoozed and a snoozed_until time, or the API rejects the call. Output

Inboxes

get

inboxes.get Read one inbox with its name and workspace url Risk: read
Input Output

list

inboxes.list List the inboxes in the workspace Risk: read
Input Output

Messages

get

messages.get Read one message with its content, direction and status Risk: read
Input Output

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
Input Delivers to a real person on the channel named in from. The content has to suit that channel, and the spec caps to at one recipient.
Output