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

Analytics

createReport

analytics.createReport Queue an analytics report for a period and optional team, user, label, and account filters, and get the report id to poll Risk: write
Input
Output

getReport

analytics.getReport Fetch a queued analytics report by id; an empty 404 means it is still generating or already expired Risk: read
Input Output: Record<string, any>

Contact Books

list

contactBooks.list List contact books the authenticated user has access to; a book id is required to create contacts Risk: read
Input Output

Contact Groups

list

contactGroups.list List the groups or organizations linked to a contact book Risk: read
Input Output

Contacts

create

contacts.create Create one or more contacts in a contact book Risk: write
Input
Output

get

contacts.get Fetch a contact by id; deleted contacts answer 404 Risk: read
Input Output

list

contacts.list List or search the contacts of a contact book, ordered by last name unless order is last_modified Risk: read
Input Output

update

contacts.update Update one or more contacts; infos and memberships replace the current ones when passed Risk: write
Input
Output

Conversations

get

conversations.get Fetch a conversation by id; a merged old id answers with the current conversation Risk: read
Input Output

list

conversations.list List conversations of one mailbox, shared label, or team, newest activity first Risk: read
Input Output

listComments

conversations.listComments List the internal comments of a conversation, newest first Risk: read
Input Output

listDrafts

conversations.listDrafts List the draft messages of a conversation, newest first Risk: read
Input Output

listMessages

conversations.listMessages List the messages of a conversation, newest first; drafts are excluded Risk: read
Input Output

listPosts

conversations.listPosts List the posts of a conversation, newest first Risk: read
Input Output

merge

conversations.merge Merge a conversation into a target conversation; the source is marked as replaced Risk: destructive · Irreversible
Input
Output

update

conversations.update Silently close, reopen, move, assign, label, recolor, or rename one or more conversations without adding a post Risk: write
Input
Output

Drafts

create

drafts.create Create an email, SMS, WhatsApp, or live chat draft in a new or existing conversation; send true delivers it to the real recipients at once and send_at schedules it, and a delivered message cannot be recalled Risk: write
Input
Output: undefined \| object

delete

drafts.delete Delete a draft from its conversation Risk: destructive · Irreversible
Input Output: undefined

Hooks

create

hooks.create Create a webhook subscription for incoming-message or new-comment events, backed by a Missive rule Risk: write
Input
Output

delete

hooks.delete Delete a webhook subscription and its backing rule Risk: destructive · Irreversible
Input Output: undefined

Messages

create

messages.create Create an incoming message in a custom channel to ingest an external conversation event Risk: write
Input
Output: undefined \| object

get

messages.get Fetch one or more messages with headers, body, and attachments by message id Risk: read
Input Output

list

messages.list Fetch the messages matching an email Message-ID header, latest first Risk: read
Input Output

Organizations

list

organizations.list List organizations the authenticated user is part of Risk: read
Input Output

Posts

create

posts.create Create a post in a new or existing conversation to inject content and close, reopen, assign, or label the conversation with a visible trace; every teammate with access sees the post and gets its notification Risk: write
Input
Output

delete

posts.delete Delete a post from its conversation Risk: destructive · Irreversible
Input Output: undefined

Responses

create

responses.create Create one or more saved response templates Risk: write
Input
Output

delete

responses.delete Delete one or more saved response templates Risk: destructive · Irreversible
Input Output: undefined

get

responses.get Fetch a saved response by id Risk: read
Input Output

list

responses.list List saved responses (canned replies) for the authenticated user Risk: read
Input Output

update

responses.update Update one or more saved responses; attachments replace the current ones when passed Risk: write
Input
Output

Shared Labels

create

sharedLabels.create Create one or more shared labels in an organization Risk: write
Input
Output

list

sharedLabels.list List shared labels in organizations the authenticated user has access to Risk: read
Input Output

update

sharedLabels.update Update one or more shared labels; visibility and sharing are admin-only fields Risk: write
Input
Output

Tasks

create

tasks.create Create a standalone task, tasked conversation, or conversation subtask Risk: write
Input
Output

get

tasks.get Fetch a task with full assignee and team details by id Risk: read
Input Output

list

tasks.list List tasks the token owner has access to, filtered by organization, team, assignee, state, type, or due window Risk: read
Input Output

update

tasks.update Update a task title, description, state, assignees, team, or due date Risk: write
Input
Output

Teams

create

teams.create Create a team in an organization; the token owner must be an admin or owner Risk: write
Input
Output

list

teams.list List teams in organizations the authenticated user has access to Risk: read
Input Output

update

teams.update Update one or more teams; the token owner must be an admin or owner Risk: write
Input
Output

Users

list

users.list List users in organizations the authenticated user is part of; user status is not exposed by the API Risk: read
Input Output