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

Contacts

create

contacts.create Create a new contact Risk: write
Input
Output

get

contacts.get Get a contact by ID Risk: read
Input Output

list

contacts.list List contacts with pagination Risk: read
Input Output

contacts.search Search contacts by term Risk: read
Input Output

update

contacts.update Update an existing contact by ID Risk: write
Input
Output

Conversations

assign

conversations.assign Assign conversation to a user Risk: write
Input Output

close

conversations.close Close conversations by ID Risk: write
Input Output

delete

conversations.delete Permanently delete conversations Risk: destructive
Input Output

get

conversations.get Get a conversation by inbox and conversation ID Risk: read
Input Output

list

conversations.list List conversations with filters and pagination Risk: read
Input Output

moveToInbox

conversations.moveToInbox Move conversations back to inbox Risk: write
Input Output

spam

conversations.spam Mark conversations as spam Risk: write
Input Output

trash

conversations.trash Move conversations to trash Risk: write
Input Output

Custom Fields

create

customFields.create Create a new custom field Risk: write
Input Output

delete

customFields.delete Delete a custom field by ID Risk: destructive
Input Output

get

customFields.get Get custom field details by ID Risk: read
Input Output

list

customFields.list List all custom fields Risk: read
Input: empty object Output

listByInbox

customFields.listByInbox List custom fields enabled for an inbox Risk: read
Input Output

update

customFields.update Update a custom field by ID Risk: write
Input Output

updateByInbox

customFields.updateByInbox Update inbox custom field visibility Risk: write
Input Output

Inboxes

get

inboxes.get Get mailbox details by ID Risk: read
Input Output

list

inboxes.list List shared mailboxes and inboxes Risk: read
Input Output

Messages

listEmails

messages.listEmails List emails in a conversation thread Risk: read
Input Output

sendChat

messages.sendChat Send a live chat message in a thread Risk: destructive
Input Output

sendEmail

messages.sendEmail Send an email message through a Helpwise mailbox Risk: destructive
Input Output

sendSms

messages.sendSms Send an SMS message Risk: destructive
Input Output

sendWhatsApp

messages.sendWhatsApp Send a WhatsApp message Risk: destructive
Input
Output

Notes

create

notes.create Add an internal note to a conversation thread Risk: write
Input Output

Reports

getOverall

reports.getOverall Get overall account analytics report Risk: read
Input Output: Record<string, any>

getTags

reports.getTags Get tag analytics report for an inbox Risk: read
Input Output

Tags

apply

tags.apply Apply tags to conversations Risk: write
Input Output

get

tags.get Get tag details by ID Risk: read
Input Output

list

tags.list List all tags Risk: read
Input: empty object Output: object[] \| null

remove

tags.remove Remove tags from conversations Risk: write
Input Output

Users

getMe

users.getMe Get current authenticated user profile Risk: read
Input: empty object Output

list

users.list List users in account or mailbox Risk: read
Input Output

Whatsapp

listTemplates

whatsapp.listTemplates List WhatsApp message templates Risk: read
Input Output