Conversations
create
conversations.create
Create a new conversation with initial thread
Risk: destructive
customer full type
customer full type
threads full type
threads full type
fields full type
fields full type
delete
conversations.delete
Delete a conversation permanently
Risk: destructive
Record<string, any>
get
conversations.get
Get a specific Help Scout conversation by ID
Risk: read
assignee full type
assignee full type
createdBy full type
createdBy full type
customer full type
customer full type
source full type
source full type
_embedded full type
_embedded full type
list
conversations.list
List and filter conversations in Help Scout
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
update
conversations.update
Update fields of a conversation via JSON Patch
Risk: write
Record<string, any>
updateFields
conversations.updateFields
Update custom field values on a conversation
Risk: destructive
fields full type
fields full type
Record<string, any>
updateTags
conversations.updateTags
Update tags assigned to a conversation
Risk: destructive
Record<string, any>
Customers
create
customers.create
Create a new customer profile
Risk: write
emails full type
emails full type
phones full type
phones full type
address full type
address full type
chats full type
chats full type
websites full type
websites full type
createAddress
customers.createAddress
Create customer physical address
Risk: write
Record<string, any>
createChat
customers.createChat
Add a chat handle to a customer
Risk: write
createEmail
customers.createEmail
Add an email address to a customer
Risk: write
createPhone
customers.createPhone
Add a phone number to a customer
Risk: write
createSocialProfile
customers.createSocialProfile
Add a social profile to a customer
Risk: write
createWebsite
customers.createWebsite
Add a website URL to a customer
Risk: write
delete
customers.delete
Delete a customer with their conversations and survey responses (cannot be undone)
Risk: destructive
Record<string, any>
deleteAddress
customers.deleteAddress
Delete customer physical address
Risk: destructive
Record<string, any>
deleteChat
customers.deleteChat
Delete a chat handle from a customer
Risk: destructive
Record<string, any>
deleteEmail
customers.deleteEmail
Delete an email address from a customer
Risk: destructive
Record<string, any>
deletePhone
customers.deletePhone
Delete a phone number from a customer
Risk: destructive
Record<string, any>
deleteSocialProfile
customers.deleteSocialProfile
Delete a social profile from a customer
Risk: destructive
Record<string, any>
deleteWebsite
customers.deleteWebsite
Delete a website URL from a customer
Risk: destructive
Record<string, any>
get
customers.get
Get details of a specific customer by ID
Risk: read
_embedded full type
_embedded full type
list
customers.list
List and search customers in Help Scout
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
patch
customers.patch
Partially update customer profile fields
Risk: write
value full type
value full type
Record<string, any>
update
customers.update
Overwrite an existing customer profile
Risk: destructive
Record<string, any>
updateAddress
customers.updateAddress
Update customer physical address
Risk: write
Record<string, any>
updateChat
customers.updateChat
Update an existing customer chat handle
Risk: write
Record<string, any>
updateEmail
customers.updateEmail
Update an existing customer email address
Risk: write
Record<string, any>
updatePhone
customers.updatePhone
Update an existing customer phone number
Risk: write
Record<string, any>
updateSocialProfile
customers.updateSocialProfile
Update an existing customer social profile
Risk: write
Record<string, any>
updateWebsite
customers.updateWebsite
Update an existing customer website URL
Risk: write
Record<string, any>
Custom Fields
list
customFields.list
List custom fields configured on a mailbox
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
Folders
list
folders.list
List folders belonging to a mailbox
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
Mailboxes
get
mailboxes.get
Get details of a specific Help Scout mailbox
Risk: read
list
mailboxes.list
List mailboxes in Help Scout
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
Reports
getChat
reports.getChat
Get live chat channel report metrics
Risk: read
Record<string, any>
getCompany
reports.getCompany
Get overall company performance report metrics
Risk: read
Record<string, any>
getConversations
reports.getConversations
Get aggregate conversations report metrics
Risk: read
Record<string, any>
getDocs
reports.getDocs
Get Help Scout Docs knowledge base report metrics
Risk: read
Record<string, any>
getEmail
reports.getEmail
Get email channel performance report metrics
Risk: read
Record<string, any>
Saved Replies
create
savedReplies.create
Create a saved reply in a mailbox
Risk: write
delete
savedReplies.delete
Delete a saved reply from a mailbox
Risk: destructive
Record<string, any>
get
savedReplies.get
Get a saved reply by ID
Risk: read
list
savedReplies.list
List saved replies for a mailbox
Risk: read
object[] \| object
Output full type
Output full type
update
savedReplies.update
Update an existing saved reply
Risk: write
Record<string, any>
Tags
get
tags.get
Get details of a tag by ID
Risk: read
list
tags.list
List all tags used across mailboxes
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
Threads
createChat
threads.createChat
Create a chat thread on a conversation
Risk: write
customer full type
customer full type
attachments full type
attachments full type
createCustomer
threads.createCustomer
Create a customer message thread on a conversation
Risk: write
customer full type
customer full type
attachments full type
attachments full type
createNote
threads.createNote
Create an internal note thread on a conversation
Risk: write
attachments full type
attachments full type
createPhone
threads.createPhone
Create a phone call log thread on a conversation
Risk: write
customer full type
customer full type
attachments full type
attachments full type
createReply
threads.createReply
Create a reply thread sent to the customer
Risk: destructive
customer full type
customer full type
attachments full type
attachments full type
getOriginalSource
threads.getOriginalSource
Get original email source of a thread
Risk: read
list
threads.list
List all threads in a conversation
Risk: read
_embedded full type
_embedded full type
_links full type
_links full type
page full type
page full type
update
threads.update
Update thread text or visibility
Risk: write
Record<string, any>