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

Conversations

create

conversations.create Create a new conversation with initial thread Risk: destructive
Input
Output

delete

conversations.delete Delete a conversation permanently Risk: destructive
Input Output: Record<string, any>

get

conversations.get Get a specific Help Scout conversation by ID Risk: read
Input Output

list

conversations.list List and filter conversations in Help Scout Risk: read
Input Output

update

conversations.update Update fields of a conversation via JSON Patch Risk: write
Input Output: Record<string, any>

updateFields

conversations.updateFields Update custom field values on a conversation Risk: destructive
Input
Output: Record<string, any>

updateTags

conversations.updateTags Update tags assigned to a conversation Risk: destructive
Input Output: Record<string, any>

Customers

create

customers.create Create a new customer profile Risk: write
Input
Output

createAddress

customers.createAddress Create customer physical address Risk: write
Input Output: Record<string, any>

createChat

customers.createChat Add a chat handle to a customer Risk: write
Input Output

createEmail

customers.createEmail Add an email address to a customer Risk: write
Input Output

createPhone

customers.createPhone Add a phone number to a customer Risk: write
Input Output

createSocialProfile

customers.createSocialProfile Add a social profile to a customer Risk: write
Input Output

createWebsite

customers.createWebsite Add a website URL to a customer Risk: write
Input Output

delete

customers.delete Delete a customer with their conversations and survey responses (cannot be undone) Risk: destructive
Input Output: Record<string, any>

deleteAddress

customers.deleteAddress Delete customer physical address Risk: destructive
Input Output: Record<string, any>

deleteChat

customers.deleteChat Delete a chat handle from a customer Risk: destructive
Input Output: Record<string, any>

deleteEmail

customers.deleteEmail Delete an email address from a customer Risk: destructive
Input Output: Record<string, any>

deletePhone

customers.deletePhone Delete a phone number from a customer Risk: destructive
Input Output: Record<string, any>

deleteSocialProfile

customers.deleteSocialProfile Delete a social profile from a customer Risk: destructive
Input Output: Record<string, any>

deleteWebsite

customers.deleteWebsite Delete a website URL from a customer Risk: destructive
Input Output: Record<string, any>

get

customers.get Get details of a specific customer by ID Risk: read
Input Output

list

customers.list List and search customers in Help Scout Risk: read
Input Output

patch

customers.patch Partially update customer profile fields Risk: write
Input
Output: Record<string, any>

update

customers.update Overwrite an existing customer profile Risk: destructive
Input Output: Record<string, any>

updateAddress

customers.updateAddress Update customer physical address Risk: write
Input Output: Record<string, any>

updateChat

customers.updateChat Update an existing customer chat handle Risk: write
Input Output: Record<string, any>

updateEmail

customers.updateEmail Update an existing customer email address Risk: write
Input Output: Record<string, any>

updatePhone

customers.updatePhone Update an existing customer phone number Risk: write
Input Output: Record<string, any>

updateSocialProfile

customers.updateSocialProfile Update an existing customer social profile Risk: write
Input Output: Record<string, any>

updateWebsite

customers.updateWebsite Update an existing customer website URL Risk: write
Input Output: Record<string, any>

Custom Fields

list

customFields.list List custom fields configured on a mailbox Risk: read
Input Output

Folders

list

folders.list List folders belonging to a mailbox Risk: read
Input Output

Mailboxes

get

mailboxes.get Get details of a specific Help Scout mailbox Risk: read
Input Output

list

mailboxes.list List mailboxes in Help Scout Risk: read
Input Output

Reports

getChat

reports.getChat Get live chat channel report metrics Risk: read
Input Output: Record<string, any>

getCompany

reports.getCompany Get overall company performance report metrics Risk: read
Input Output: Record<string, any>

getConversations

reports.getConversations Get aggregate conversations report metrics Risk: read
Input Output: Record<string, any>

getDocs

reports.getDocs Get Help Scout Docs knowledge base report metrics Risk: read
Input Output: Record<string, any>

getEmail

reports.getEmail Get email channel performance report metrics Risk: read
Input Output: Record<string, any>

Saved Replies

create

savedReplies.create Create a saved reply in a mailbox Risk: write
Input Output

delete

savedReplies.delete Delete a saved reply from a mailbox Risk: destructive
Input Output: Record<string, any>

get

savedReplies.get Get a saved reply by ID Risk: read
Input Output

list

savedReplies.list List saved replies for a mailbox Risk: read
Input Output: object[] \| object

update

savedReplies.update Update an existing saved reply Risk: write
Input Output: Record<string, any>

Tags

get

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

list

tags.list List all tags used across mailboxes Risk: read
Input Output

Threads

createChat

threads.createChat Create a chat thread on a conversation Risk: write
Input
Output

createCustomer

threads.createCustomer Create a customer message thread on a conversation Risk: write
Input
Output

createNote

threads.createNote Create an internal note thread on a conversation Risk: write
Input
Output

createPhone

threads.createPhone Create a phone call log thread on a conversation Risk: write
Input
Output

createReply

threads.createReply Create a reply thread sent to the customer Risk: destructive
Input
Output

getOriginalSource

threads.getOriginalSource Get original email source of a thread Risk: read
Input Output

list

threads.list List all threads in a conversation Risk: read
Input Output

update

threads.update Update thread text or visibility Risk: write
Input Output: Record<string, any>