New to Corsair? See API access, authentication, and error handling.
Contacts
create
contacts.create
Create a new contact
Risk: write
phones full type
phones full type
customFields full type
customFields full type
get
contacts.get
Get a contact by ID
Risk: read
Output
list
contacts.list
List contacts with pagination
Risk: read
Output
results full type
results full type
search
contacts.search
Search contacts by term
Risk: read
Output
result full type
result full type
results full type
results full type
update
contacts.update
Update an existing contact by ID
Risk: write
phones full type
phones full type
customFields full type
customFields full type
Conversations
assign
conversations.assign
Assign conversation to a user
Risk: write
Output
close
conversations.close
Close conversations by ID
Risk: write
Output
delete
conversations.delete
Permanently delete conversations
Risk: destructive
Output
get
conversations.get
Get a conversation by inbox and conversation ID
Risk: read
Output
list
conversations.list
List conversations with filters and pagination
Risk: read
Output
threads full type
threads full type
moveToInbox
conversations.moveToInbox
Move conversations back to inbox
Risk: write
Output
spam
conversations.spam
Mark conversations as spam
Risk: write
Output
trash
conversations.trash
Move conversations to trash
Risk: write
Output
Custom Fields
create
customFields.create
Create a new custom field
Risk: write
Output
delete
customFields.delete
Delete a custom field by ID
Risk: destructive
Output
get
customFields.get
Get custom field details by ID
Risk: read
Output
list
customFields.list
List all custom fields
Risk: read
listByInbox
customFields.listByInbox
List custom fields enabled for an inbox
Risk: read
Output
update
customFields.update
Update a custom field by ID
Risk: write
Output
updateByInbox
customFields.updateByInbox
Update inbox custom field visibility
Risk: write
Output
Inboxes
get
inboxes.get
Get mailbox details by ID
Risk: read
Output
list
inboxes.list
List shared mailboxes and inboxes
Risk: read
Output
Messages
listEmails
messages.listEmails
List emails in a conversation thread
Risk: read
Output
sendChat
messages.sendChat
Send a live chat message in a thread
Risk: destructive
Output
sendEmail
messages.sendEmail
Send an email message through a Helpwise mailbox
Risk: destructive
Output
sendSms
messages.sendSms
Send an SMS message
Risk: destructive
Output
sendWhatsApp
messages.sendWhatsApp
Send a WhatsApp message
Risk: destructive
template full type
template full type
Notes
create
notes.create
Add an internal note to a conversation thread
Risk: write
Output
Reports
getOverall
reports.getOverall
Get overall account analytics report
Risk: read
Output:
Record<string, any>
getTags
reports.getTags
Get tag analytics report for an inbox
Risk: read
Output
Tags
apply
tags.apply
Apply tags to conversations
Risk: write
Output
get
tags.get
Get tag details by ID
Risk: read
Output
list
tags.list
List all tags
Risk: read
object[] \| null
Output full type
Output full type
remove
tags.remove
Remove tags from conversations
Risk: write
Output
Users
getMe
users.getMe
Get current authenticated user profile
Risk: read
list
users.list
List users in account or mailbox
Risk: read
Output
data full type
data full type
listTemplates
whatsapp.listTemplates
List WhatsApp message templates
Risk: read
Output