Help Scout

help_scout

Help Scout provides customer support software with shared inbox, knowledge base, and customer management tools

Customer Support Communication Web del proveedor

Acciones

137

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (137)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Chat HandleHELP_SCOUT_CREATE_CHAT_HANDLEAcción

Tool to create a chat handle for a Help Scout customer. Use when you need to add a chat platform username (like Skype, AIM, Yahoo) to a customer's profile.

Parámetros de entrada

typestringObligatorioenum
Chat platform type. Must be one of: aim, gtalk, icq, msn, other, qq, skype, xmpp, yahoo
aimgtalkicqmsnotherqqskypexmppyahoo
valuestringObligatorio
The chat handle/username on the specified platform
customerIdintegerObligatorio
The customer ID for whom to create the chat handle

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Chat ThreadHELP_SCOUT_CREATE_CHAT_THREADAcción

Tool to create a new chat thread on a Help Scout conversation. Use when adding a chat message to an existing conversation. Note: Conversations can have a maximum of 100 threads. Non-imported threads automatically reopen closed conversations.

Parámetros de entrada

textstringObligatorio
The chat message content.
customerobjectObligatorio
Customer details. Either customer.id or customer.email must be provided.
importedboolean
Set to true when importing historical data. Prevents notifications from being sent. Use for bulk imports or historical data migration.
createdAtstring
Custom creation timestamp for imported threads. ISO 8601 format. Only used when imported=true.
attachmentsobject[]
List of file attachments to include with the chat thread.
conversationIdintegerObligatorio
The ID of the conversation to create the chat thread on.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create ConversationHELP_SCOUT_CREATE_CONVERSATIONAcción

Tool to create a new conversation in Help Scout. Use when creating email, phone, or chat conversations with customer threads.

Parámetros de entrada

tagsstring[]
Array of tag names to apply to the conversation
typestringObligatorioenum
Conversation type: email, phone, or chat
emailphonechat
userinteger
User ID of the user who created the conversation. Only valid for imported conversations
fieldsobject[]
Array of custom field objects with id and value
statusstringenum
Conversation status: active, closed, pending, or spam
activeclosedpendingspam
subjectstringObligatorio
Subject line for the conversation
threadsobject[]Obligatorio
Array of thread objects. At least one thread is required to create a conversation
assignTointeger
User ID to assign the conversation to
closedAtstring
Closed date in ISO 8601 format (e.g., 2024-01-15T12:00:00Z). Only valid when status is closed
customerobjectObligatorio
Customer object with email or id. At least one must be provided
importedboolean
Set to true if this is an imported conversation. When true, no notifications are sent and the conversation is marked as imported
createdAtstring
Created date in ISO 8601 format (e.g., 2024-01-15T10:30:00Z). Only valid for imported conversations
mailboxIdintegerObligatorio
ID of the mailbox where conversation will be created

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create CustomerHELP_SCOUT_CREATE_CUSTOMERAcción

Tool to create a new customer in Help Scout with contact details and profile information. Use when you need to add a new customer with emails, phones, addresses, or other contact data.

Parámetros de entrada

agestring
Age or age range
chatsobject[]
Array of chat handle objects with type and value
emailsobject[]
Array of email objects with type and value. At least one email is recommended for customer identification.
genderstring
Gender: male, female, or unknown
phonesobject[]
Array of phone objects with type and value
addressobject
Address object with location details.
jobTitlestring
Job title (max 60 characters)
lastNamestring
Customer's last name (1-40 characters)
photoUrlstring
URL to profile photo (max 200 characters)
websitesstring[]
Array of website URLs
firstNamestring
Customer's first name (1-40 characters)
backgroundstring
Background information or notes (max 200 characters)
organizationstring
Organization name
socialProfilesobject[]
Array of social profile objects with type and value

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Customer AddressHELP_SCOUT_CREATE_CUSTOMER_ADDRESSAcción

Tool to create an address for a Help Scout customer. Use when you need to add a physical address to a customer's profile.

Parámetros de entrada

citystringObligatorio
City of the address.
linesstring[]
Address lines (street address, building number, etc.).
statestringObligatorio
State or province of the address.
countrystringObligatorio
Country code of the address (typically 2-letter ISO code).
customer_idintegerObligatorio
The unique identifier for the customer.
postal_codestringObligatorio
Postal code or ZIP code of the address.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create customer emailHELP_SCOUT_CREATE_CUSTOMER_EMAILAcción

Tool to create an email for a customer in Help Scout. Use when you need to add a new email address to a customer's profile.

Parámetros de entrada

typestringObligatorioenum
Email category - home, other, or work
homeotherwork
valuestringObligatorio
Email address to add for the customer
customer_idstringObligatorio
Identifier of the customer to add the email to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Customer PhoneHELP_SCOUT_CREATE_CUSTOMER_PHONEAcción

Tool to create a phone number for a Help Scout customer. Use when adding contact phone numbers to customer profiles.

Parámetros de entrada

typestringObligatorioenum
Phone location type (fax, home, mobile, other, pager, or work)
faxhomemobileotherpagerwork
valuestringObligatorio
The telephone number
customer_idintegerObligatorio
The customer ID to add the phone number to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Customer PropertyHELP_SCOUT_CREATE_CUSTOMER_PROPERTYAcción

Tool to create a customer property definition in Help Scout. Use when you need to add custom fields to track additional customer information like subscription plan, tier level, or custom attributes. Maximum 50 customer property definitions per company.

Parámetros de entrada

namestringObligatorio
Human-readable display name for the property
slugstringObligatorio
Unique identifier for the property (1-100 characters, alphanumeric with hyphens/underscores only). Cannot be 'email', 'name', 'company', or 'jobTitle' as these are reserved
typestringObligatorioenum
Type of the property. Use 'dropdown' for predefined options, 'number' for numeric values, 'text' for free-form text, 'url' for web links, or 'date' for date values
numbertexturldatedropdown
optionsobject[]
List of dropdown options (max 100). Required when type is 'dropdown', ignored for other types. Each option must have a unique label

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Customer ThreadHELP_SCOUT_CREATE_CUSTOMER_THREADAcción

Tool to create a new customer thread on a Help Scout conversation. Use when a customer needs to add a message to an existing conversation. The conversation will reopen unless imported mode is enabled. Conversations are limited to 100 threads maximum.

Parámetros de entrada

ccstring[]
List of email addresses to CC on the thread
bccstring[]
List of email addresses to BCC on the thread
textstringObligatorio
The message text content for the thread
customerobjectObligatorio
Customer object. Must include either id or email field
importedboolean
Enables historical import mode. When true, no notifications are generated and the conversation remains in its current state
createdAtstring
Custom creation date for imports (ISO 8601 format). Only used when imported is true
attachmentsobject[]
Optional list of attachments to include with the thread
conversationIdintegerObligatorio
The ID of the conversation to add the thread to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Customer WebsiteHELP_SCOUT_CREATE_CUSTOMER_WEBSITEAcción

Tool to create a website entry for a customer in Help Scout. Use when adding a website URL to an existing customer profile.

Parámetros de entrada

valuestringObligatorio
The website URL to add to the customer profile
customer_idintegerObligatorio
The ID of the customer to add the website to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Note on ConversationHELP_SCOUT_CREATE_NOTEAcción

Tool to create a new note thread on a Help Scout conversation. Use when you need to add internal notes to conversations. Notes are visible only to team members, not customers. Maximum 100 threads per conversation.

Parámetros de entrada

textstringObligatorio
The note text content
userinteger
User ID adding the thread; defaults to resource owner if omitted
statusstringenum
Conversation status options.
activeclosedinbox_predefinedopenpendingspam
importedboolean
Enables thread creation for historical purposes; prevents outgoing emails/notifications when true
createdAtstring
Historical creation date in ISO 8601 format; only usable when imported is true
attachmentsobject[]
Optional list of attachment objects to include with the note
conversationIdintegerObligatorio
The ID of the conversation to add the note to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create OrganizationHELP_SCOUT_CREATE_ORGANIZATIONAcción

Tool to create a new organization in Help Scout. Use when you need to create a company profile with associated domains, contact information, and metadata.

Parámetros de entrada

namestringObligatorio
Organization name (required)
notestring
Internal notes about the organization (visible only to team members)
phonesstring[]
Array of phone numbers associated with the organization
domainsstring[]
Array of domain strings associated with the organization
websitestring
Organization website URL
locationstring
Physical location of the organization
brandColorstring
Brand color in hex format (e.g., #FF5733)
descriptionstring
Description of the organization

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Organization PropertyHELP_SCOUT_CREATE_ORGANIZATION_PROPERTYAcción

Tool to create a new custom property definition for organizations in Help Scout. Use when you need to add custom fields to track organization-specific data like industry, account tier, renewal dates, or other metadata. Maximum 50 property definitions allowed per account.

Parámetros de entrada

namestringObligatorio
Human-readable display name for the property shown in the UI; maximum 100 characters
slugstringObligatorio
Unique logical identifier for the property within the account; must be 1-120 characters in length. Used as the property key in API calls.
typestringObligatorioenum
Property data type. Valid values: text (plain text), number (numeric values), url (web addresses), date (date values), dropdown (selection list)
textnumberurldatedropdown
optionsobject[]
Array of dropdown choices; required when type is 'dropdown', ignored otherwise. Maximum 100 options allowed per property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Phone ThreadHELP_SCOUT_CREATE_PHONE_THREADAcción

Tool to create a new phone thread on a Help Scout conversation. Use when you need to log a phone call interaction with a customer on an existing conversation.

Parámetros de entrada

textstringObligatorio
The phone conversation text describing the call details
customerobjectObligatorio
Customer object with ID or email (at least one required)
importedboolean
Set to true to create a historical thread without sending notifications or reopening the conversation
createdAtstring
Optional creation date in ISO 8601 format. Requires imported to be true
attachmentsobject[]
List of file attachments to include with the phone thread
conversationIdintegerObligatorio
The ID of the conversation to add the phone thread to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Reply ThreadHELP_SCOUT_CREATE_REPLY_THREADAcción

Tool to create a new reply thread on a Help Scout conversation. Use when sending a reply to a customer in an existing conversation. The reply can be published immediately or saved as a draft.

Parámetros de entrada

ccstring[]
Array of CC email addresses
bccstring[]
Array of BCC email addresses
textstringObligatorio
Reply text content (HTML supported)
userintegerObligatorio
Help Scout user ID sending the reply
draftboolean
When true, creates a draft reply instead of publishing immediately. Defaults to false
statusstringenum
Conversation status options.
activeclosedpendingspamopeninbox_predefined
assignTointeger
User ID to assign the conversation to after publishing the reply
customerobjectObligatorio
Customer object with id field
importedboolean
Set to true for historical/imported replies. Prevents outgoing emails and notifications
createdAtstring
Historical creation date in ISO 8601 format (e.g., 2024-01-15T10:30:00Z). Only valid when imported is true
attachmentsobject[]
Array of attachment objects to include with the reply
conversation_idintegerObligatorio
ID of the conversation to reply to

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create saved replyHELP_SCOUT_CREATE_SAVED_REPLYAcción

Tool to create a saved reply for a mailbox in Help Scout. Use when you need to create reusable message templates for email or chat responses.

Parámetros de entrada

namestringObligatorio
The name of the saved reply. This is used to identify and search for the reply.
textstring
The saved reply's text content for email messages. Supports HTML formatting with tags like <br /> for line breaks.
chatTextstring
The saved reply's text content for chat messages. Use plain text with newline characters (\n) for line breaks instead of HTML.
mailboxIdintegerObligatorio
The mailbox ID where the saved reply will be created. This identifies which mailbox the saved reply belongs to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create Social ProfileHELP_SCOUT_CREATE_SOCIAL_PROFILEAcción

Tool to create a social profile for a customer in Help Scout. Use when you need to add social media profile information (LinkedIn, Twitter, Facebook, etc.) to a customer record.

Parámetros de entrada

typestringObligatorioenum
The type of social profile (e.g., linkedin, twitter, facebook, instagram, youtube, pinterest, github, or other).
twitterfacebooklinkedininstagramyoutubepinterestgithubother
valuestringObligatorio
The social profile URL or handle. For URLs, provide the full URL (e.g., 'https://linkedin.com/in/testuser123'). For handles, provide the username.
customerIdintegerObligatorio
The unique identifier of the customer to add the social profile to.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Create WebhookHELP_SCOUT_CREATE_WEBHOOKAcción

Tool to create a new webhook subscription in Help Scout to receive real-time event notifications. Use when setting up webhook integrations to track conversations, customers, tags, or other events.

Parámetros de entrada

urlstringObligatorio
The callback URL where webhook events will be sent
labelstring
Label to identify the webhook
statestringenum
Webhook state.
enableddisabled
eventsstring[]Obligatorio
Array of event names to subscribe to for webhook notifications
secretstringObligatorio
Secret key for webhook signature verification (max 40 characters)
mailboxIdsinteger[]
Array of mailbox IDs to scope webhook to specific mailboxes. If omitted, webhook applies to all mailboxes
notificationboolean
If true, sends only resource URI instead of full payload
payloadVersionstringenum
Webhook payload version.
V2

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Chat HandleHELP_SCOUT_DELETE_CHAT_HANDLEAcción

Tool to delete a chat handle for a customer. Use when you need to remove a chat handle associated with a customer account.

Parámetros de entrada

chat_idstringObligatorio
The unique identifier for the chat handle to be deleted
customer_idstringObligatorio
The unique identifier for the customer

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete ConversationHELP_SCOUT_DELETE_CONVERSATIONAcción

Tool to move a conversation to the deleted folder. Use when you need to delete a conversation. The conversation can only be restored by a Help Scout administrator.

Parámetros de entrada

conversation_idstringObligatorio
The unique identifier of the conversation to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete customerHELP_SCOUT_DELETE_CUSTOMERAcción

Tool to permanently delete a customer by ID from Help Scout. This hard-deletes the customer including microsurvey responses and conversations (irreversible, GDPR compliant). Returns 403 if user lacks access to all conversations or customer has >100 conversations.

Parámetros de entrada

customer_idintegerObligatorio
The customer identifier to delete. This will permanently delete the customer including microsurvey responses and conversations.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer AddressHELP_SCOUT_DELETE_CUSTOMER_ADDRESSAcción

Tool to delete a customer's address from Help Scout. Use when you need to remove address information associated with a specific customer account.

Parámetros de entrada

customer_idintegerObligatorio
The unique identifier for the customer whose address should be removed

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer AsynchronouslyHELP_SCOUT_DELETE_CUSTOMER_ASYNCAcción

Tool to delete a customer asynchronously. Use when you need to permanently remove a customer, their survey responses, and associated conversations. The deletion occurs asynchronously after the API returns 202 Accepted. To track completion, register a webhook listener for the customer.deleted event.

Parámetros de entrada

customer_idstringObligatorio
The unique identifier of the customer to be removed

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer EmailHELP_SCOUT_DELETE_CUSTOMER_EMAILAcción

Tool to delete an email for a customer. Use when you need to remove a customer's email address from Help Scout.

Parámetros de entrada

email_idstringObligatorio
The email identifier to delete
customer_idstringObligatorio
The customer identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer PhoneHELP_SCOUT_DELETE_CUSTOMER_PHONEAcción

Tool to delete a customer's phone number from Help Scout. Use when you need to remove a phone number associated with a specific customer account.

Parámetros de entrada

phone_idintegerObligatorio
The unique identifier for the phone number to delete
customer_idintegerObligatorio
The unique identifier for the customer whose phone should be removed

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer PropertyHELP_SCOUT_DELETE_CUSTOMER_PROPERTYAcción

Tool to perform a soft delete on a customer property definition. The property is scheduled for permanent deletion, with its slug temporarily reassigned during the grace period.

Parámetros de entrada

slugstringObligatorio
The unique identifier (slug) for the customer property to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Customer WebsiteHELP_SCOUT_DELETE_CUSTOMER_WEBSITEAcción

Tool to delete a website for a customer. Use when you need to remove a website from a customer record.

Parámetros de entrada

website_idstringObligatorio
The unique identifier for the website to be deleted
customer_idstringObligatorio
The unique identifier for the customer

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete OrganizationHELP_SCOUT_DELETE_ORGANIZATIONAcción

Tool to delete an organization by ID. Use when removing an organization from Help Scout. This operation also removes the reference to this organization from all associated customers.

Parámetros de entrada

organization_idintegerObligatorio
The organization's unique identifier to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Organization Property Customer TierHELP_SCOUT_DELETE_ORGANIZATION_PROPERTY_CUSTOMER_TIERAcción

Tool to delete a customer tier property definition from organizations. This performs a soft-delete, and the property will be removed permanently after a grace period. Use when you need to remove a custom organization property definition.

Parámetros de entrada

slugstringObligatorio
The property definition identifier slug. Use 'customer-tier' to delete the customer tier property.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Organization PropertyHELP_SCOUT_DELETE_ORG_PROPERTYAcción

Tool to delete an organization property definition. This performs a soft delete, and the property will be removed permanently after a grace period. Use when you need to remove a custom property from organizations.

Parámetros de entrada

property_idstringObligatorio
The property definition identifier (slug) to be deleted

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Saved ReplyHELP_SCOUT_DELETE_SAVED_REPLYAcción

Tool to delete a saved reply from a mailbox. Use when you need to permanently remove a saved reply. Returns 204 No Content on successful deletion.

Parámetros de entrada

mailboxIdstringObligatorio
The unique identifier for the mailbox containing the saved reply to delete.
savedReplyIdstringObligatorio
The unique identifier for the saved reply to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete SnoozeHELP_SCOUT_DELETE_SNOOZEAcción

Tool to delete a snooze on a conversation. Use when you need to remove a snooze from a conversation, which will place it into its new home folder (Mine, Team or Unassigned, based on assignee).

Parámetros de entrada

conversation_idstringObligatorio
The unique identifier of the conversation to remove the snooze from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Social ProfileHELP_SCOUT_DELETE_SOCIAL_PROFILEAcción

Tool to delete a social profile for a customer in Help Scout. Use when you need to remove a social media profile link from a customer record.

Parámetros de entrada

customerIdintegerObligatorio
The unique identifier of the customer who owns the social profile.
socialProfileIdintegerObligatorio
The unique identifier of the social profile to delete.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete Thread ScheduleHELP_SCOUT_DELETE_THREAD_SCHEDULEAcción

Tool to unschedule a scheduled thread in a conversation. Use when you need to convert a scheduled thread to a draft thread. The scheduled thread will be converted to a standard draft thread.

Parámetros de entrada

thread_idintegerObligatorio
The unique identifier of the thread to unschedule
conversation_idintegerObligatorio
The unique identifier of the conversation containing the thread

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Delete WebhookHELP_SCOUT_DELETE_WEBHOOKAcción

Tool to permanently delete a webhook subscription from Help Scout. Use when you need to remove webhook integrations that are no longer needed.

Parámetros de entrada

webhook_idintegerObligatorio
The unique identifier of the webhook to delete

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Download AttachmentHELP_SCOUT_DOWNLOAD_ATTACHMENTAcción

Tool to download an attachment file from a Help Scout conversation. Use when you need to retrieve the actual file content of an attachment.

Parámetros de entrada

attachment_idintegerObligatorio
The unique identifier of the attachment file to download
conversation_idintegerObligatorio
The unique identifier of the conversation containing the attachment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Attachment DataHELP_SCOUT_GET_ATTACHMENT_DATAAcción

Tool to retrieve attachment data for a specific attachment. Returns base64-encoded attachment content.

Parámetros de entrada

attachment_idstringObligatorio
The unique identifier of the attachment to retrieve
conversation_idstringObligatorio
The unique identifier of the conversation containing the attachment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Busy Times ReportHELP_SCOUT_GET_BUSY_TIMES_REPORTAcción

Tool to get busiest time of day report showing conversation volume by day and hour. Use when you need to analyze conversation patterns to identify peak support hours or optimize team scheduling. Requires Plus or Pro plan.

Parámetros de entrada

endstringObligatorio
End date in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter by. Example: '10,20,30'
startstringObligatorio
Start date in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter by. Allowed values: 'email', 'chat', 'phone'
foldersstring
Comma-separated list of folder IDs to filter by. Example: '100,200'
mailboxesstring
Comma-separated list of mailbox IDs to filter by. Example: '1,2,3'
previousEndstring
Previous period end date for comparison in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Previous period start date for comparison in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Chat ReportHELP_SCOUT_GET_CHAT_REPORTAcción

Tool to retrieve comprehensive chat report statistics from Help Scout. Use when you need to analyze chat performance metrics including conversation volume, wait times, response times, message counts, and chat durations. Supports period-over-period comparisons and filtering by mailboxes, tags, or folders. Note: Only available to Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required parameter.
tagsstring
Comma-separated list of tag IDs to filter the report. Example: '99787' or '5666,99787'.
startstringObligatorio
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required parameter.
foldersstring
Comma-separated list of folder IDs to filter the report. Example: '991' or '991,992'.
mailboxesstring
Comma-separated list of mailbox/inbox IDs to filter the report. Example: '123' or '123,567'.
officeHoursboolean
Whether to take office hours into consideration in the report calculations. Defaults to false if not specified.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. If provided, previousStart must also be specified.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. If provided, previousEnd must also be specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company Customers Helped ReportHELP_SCOUT_GET_COMPANY_CUSTOMERS_HELPED_REPORTAcción

Tool to retrieve company customers helped report showing distinct customer count receiving support. Use when you need to analyze how many unique customers were helped during a specific period, compare periods, or track customer engagement trends. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
Conclusion of current time interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs for filtering. Example: '111,222,333'
startstringObligatorio
Beginning of current time interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstringenum
Types of conversations supported by Help Scout.
emailchatphone
viewBystringenum
Data resolution options for viewing report data.
dayweekmonth
foldersstring
Comma-separated list of folder IDs for filtering. Example: '10,20,30'
mailboxesstring
Comma-separated list of mailbox/inbox IDs for filtering. Example: '123,456,789'
previousEndstring
Conclusion of comparison period in ISO 8601 format. If provided, previousStart must also be provided.
previousStartstring
Beginning of comparison period in ISO 8601 format. If provided, previousEnd must also be provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company Drilldown ReportHELP_SCOUT_GET_COMPANY_DRILLDOWN_REPORTAcción

Tool to retrieve company drilldown report showing underlying conversation data for company statistics. Use when you need to analyze conversations by various dimensions like reply counts, response times, or resolution metrics. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
pageinteger
Page number for pagination. Default is 1.
rowsinteger
Results per page. Default is 25, maximum is 50.
tagsstring
Comma-separated tag IDs to filter results. Example: '100,200'
rangestringObligatorioenum
Filter dimension for drill-down: replies, firstReplyResolved, resolved, responseTime, firstResponseTime, or handleTime. Required.
repliesfirstReplyResolvedresolvedresponseTimefirstResponseTimehandleTime
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstringenum
Conversation type values.
emailchatphone
foldersstring
Comma-separated folder IDs to filter results. Example: '10,20'
rangeIdinteger
Specific range bucket ID (1-10 depending on range type)
mailboxesstring
Comma-separated inbox IDs to filter results. Example: '123,456'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Company ReportHELP_SCOUT_GET_COMPANY_REPORTAcción

Tool to retrieve overall company performance report from Help Scout. Returns metrics like customers helped, conversations closed, total replies, and per-user statistics for a specified time period. Use when you need to analyze team performance, track support metrics, or generate reports on customer service activity.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required.
tagsstring
Comma-separated list of tag IDs to filter the report. Optional.
startstringObligatorio
Start of the reporting interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
foldersstring
Comma-separated list of folder IDs to filter the report. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Optional.
previousEndstring
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get ConversationHELP_SCOUT_GET_CONVERSATIONAcción

Tool to retrieve a specific conversation by ID from Help Scout. Use when you need detailed information about a conversation including assignee, customer, tags, custom fields, and optionally embedded threads.

Parámetros de entrada

embedstring
Allows loading sub-entities. Valid value: 'threads' to include conversation threads in the response
conversation_idintegerObligatorio
Unique identifier for the conversation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversations Attachments FileHELP_SCOUT_GET_CONVERSATIONS_ATTACHMENTS_FILEAcción

Tool to download a single attachment file from a conversation. Use when you need to retrieve the actual binary file content of an attachment. Returns the file with original filename and content type.

Parámetros de entrada

attachment_idstringObligatorio
The unique identifier of the attachment file to download
conversation_idstringObligatorio
The unique identifier of the conversation containing the attachment

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversations Drilldown ReportHELP_SCOUT_GET_CONVERSATIONS_DRILLDOWNAcción

Tool to get conversations drilldown report from Help Scout. Use when you need detailed conversation data for a specific time period. Available on Plus and Pro plans only.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format
pageinteger
Page number for pagination (default: 1)
rowsinteger
Number of results per page (default: 25, max: 50)
tagsstring
Comma-separated list of tag IDs to filter by
startstringObligatorio
Beginning of the reporting interval in ISO 8601 format
typesstringenum
Conversation type options.
emailchatphone
foldersstring
Comma-separated list of folder IDs to filter by
mailboxesstring
Comma-separated list of mailbox IDs to filter by

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversations Field Drilldown ReportHELP_SCOUT_GET_CONVERSATIONS_FIELD_DRILLDOWNAcción

Tool to get conversations drilldown by field report from Help Scout. Use when you need to analyze conversations by specific tags, saved replies, workflows, or customers for a time period.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format
pageinteger
Page number for pagination (default: 1)
rowsinteger
Number of results per page (default: 25, maximum: 50)
tagsstring
Comma-separated tag IDs to filter results
fieldstringObligatorioenum
Field category to analyze; determines drill-down focus (tagid, replyid, workflowid, or customerid)
tagidreplyidworkflowidcustomerid
startstringObligatorio
Beginning of the reporting interval in ISO 8601 format
typesstring
Comma-separated conversation types to filter by. Valid values: email, chat, phone
fieldidintegerObligatorio
Specific identifier for the tag, reply, workflow, or customer to drill down into
foldersstring
Comma-separated folder IDs to filter results
mailboxesstring
Comma-separated inbox IDs to filter results

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Conversations ReportHELP_SCOUT_GET_CONVERSATIONS_REPORTAcción

Tool to get overall conversations report with statistics on conversation volume, channels, and trends. Use when you need insights on conversation patterns, busiest times, top customers, tags, or custom field analytics. Supports optional previous period comparison for trend analysis.

Parámetros de entrada

endstringObligatorio
End date in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter by. Example: '10,20,30'
startstringObligatorio
Start date in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter by. Example: 'email,chat,phone'
foldersstring
Comma-separated list of folder IDs to filter by. Example: '100,200'
mailboxesstring
Comma-separated list of mailbox IDs to filter by. Example: '1,2,3'
officeHoursboolean
Filter by office hours. Set to true to include only conversations during office hours, false for outside office hours.
previousEndstring
Previous period end date for comparison in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Previous period start date for comparison in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get CustomerHELP_SCOUT_GET_CUSTOMERAcción

Tool to get a specific customer by ID from Help Scout. Use when you need to retrieve detailed customer information including contact details, profile data, and conversation history.

Parámetros de entrada

customer_idintegerObligatorio
Unique customer identifier to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Customer AddressHELP_SCOUT_GET_CUSTOMER_ADDRESSAcción

Tool to retrieve a customer's address from Help Scout. Use when you need to fetch the physical address associated with a specific customer account.

Parámetros de entrada

customer_idintegerObligatorio
The unique identifier for the customer whose address should be retrieved.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Docs ReportHELP_SCOUT_GET_DOCS_REPORTAcción

Tool to retrieve overall docs performance report from Help Scout. Returns metrics like unique visitors, browse and search actions, popular searches, top articles, and top categories for a specified time period. Use when you need to analyze documentation usage, track knowledge base effectiveness, or identify popular content.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required.
sitesstring
Comma-separated list of docs site IDs to filter the report. Optional.
startstringObligatorio
Start of the reporting interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required.
previousEndstring
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email ReportHELP_SCOUT_GET_EMAIL_REPORTAcción

Tool to retrieve email report with volume, resolution, and response metrics from Help Scout. Returns statistics like email conversations, response times, resolution rates, and time distributions for a specified period. Use when you need detailed email performance analytics or trend comparisons.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter the report. Example: '10,20,30'
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
foldersstring
Comma-separated list of folder IDs to filter the report. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Example: '1,2,3'
officeHoursboolean
Incorporates business hours if enabled. Defaults to false. Set to true to include only emails during office hours.
previousEndstring
Conclusion timeframe for comparison analytics in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Beginning timeframe for comparison analytics in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get First Response Time ReportHELP_SCOUT_GET_FIRST_RESPONSE_TIME_REPORTAcción

Tool to retrieve first response time productivity report showing average response duration. Use when you need to analyze team response performance, track response time trends, or compare response times across different periods. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
viewBystringenum
Data resolution options for viewing report data.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
officeHoursboolean
Whether to take office hours into consideration. Set to true to filter by office hours. Office hours must be enabled to use this filter.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Happiness Ratings ReportHELP_SCOUT_GET_HAPPINESS_RATINGS_REPORTAcción

Tool to retrieve happiness ratings report with customer satisfaction scores and feedback from Help Scout. Returns paginated list of ratings including conversation details, rating scores (Great/OK/Not Good), customer comments, and associated agent information. Use when you need to analyze customer satisfaction metrics or gather feedback data.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
pageinteger
Page number for pagination. Use to retrieve subsequent pages of results.
tagsstring
Comma-separated list of tag IDs to filter the report. Example: '5666,99787'
startstringObligatorio
Start of the reporting interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter by. Valid values: email, chat, phone. Example: 'email,chat'
ratingstringenum
Enumeration for rating filter options.
greatokallnot-good
foldersstring
Comma-separated list of folder IDs to filter the report. Example: '100,200'
mailboxesstring
Comma-separated list of mailbox IDs to filter the report. Example: '123,567'
sortFieldstringenum
Enumeration for sort field options.
numbermodifiedAtrating
sortOrderstringenum
Enumeration for sort order options.
ASCDESC
previousEndstring
Prior interval end for comparison purposes in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Prior interval start for comparison purposes in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Happiness ReportHELP_SCOUT_GET_HAPPINESS_REPORTAcción

Tool to retrieve overall happiness report from Help Scout. Returns customer satisfaction metrics including ratings percentages, counts, and happiness scores for a specified time period. Use when you need to analyze customer satisfaction trends, track happiness scores, or generate reports on customer feedback.

Parámetros de entrada

endstring
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Optional.
tagsstring
Comma-separated list of tag IDs to filter the report. Optional.
startstring
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Optional.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
foldersstring
Comma-separated list of folder IDs to filter the report. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Optional.
previousEndstring
Conclusion point for prior period comparison in ISO 8601 format. Optional.
previousStartstring
Beginning point for prior period comparison in ISO 8601 format. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get InboxHELP_SCOUT_GET_INBOXAcción

Tool to retrieve a specific inbox by ID with details including name, email, and timestamps. Use when you need to get information about a particular mailbox or inbox.

Parámetros de entrada

mailbox_idstringObligatorio
Unique identifier for the inbox to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get New Conversations Drilldown ReportHELP_SCOUT_GET_NEW_CONVERSATIONS_DRILLDOWNAcción

Tool to get new conversations drilldown report showing underlying conversation data for new conversations created within a time period. Use when you need to analyze newly created conversations with detailed information. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
pageinteger
Page number for pagination. Default is 1.
rowsinteger
Results per page. Default is 25, maximum is 50.
tagsstring
Comma-separated tag IDs to filter results. Example: '100,200'
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated conversation types to filter by. Valid values: email, chat, phone
foldersstring
Comma-separated folder IDs to filter results. Example: '10,20'
mailboxesstring
Comma-separated inbox IDs to filter results. Example: '123,456'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get New Conversations ReportHELP_SCOUT_GET_NEW_CONVERSATIONS_REPORTAcción

Tool to get new conversations report showing conversation counts over time intervals. Use when you need to analyze new conversation trends, compare time periods, or track conversation volume patterns.

Parámetros de entrada

endstringObligatorio
End of the time interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated tag IDs to filter results. Example: '10,20,30'
startstringObligatorio
Start of the time interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstringenum
Types of conversations supported by Help Scout.
emailchatphone
viewBystringenum
Data resolution options for viewing report data.
dayweekmonth
foldersstring
Comma-separated folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated inbox IDs to filter results. Example: '123,456'
previousEndstring
Ending of prior comparison period in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Beginning of prior comparison period in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get OrganizationHELP_SCOUT_GET_ORGANIZATIONAcción

Tool to retrieve a specific organization by ID from Help Scout. Use when you need to fetch details about an organization including name, website, domains, and contact information.

Parámetros de entrada

includeCountsboolean
Whether to include customer and conversation counts in the response.
organization_idintegerObligatorio
The unique identifier for the organization to retrieve.
includePropertiesboolean
Whether to include organization property values in the response.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization ConversationsHELP_SCOUT_GET_ORGANIZATION_CONVERSATIONSAcción

Tool to get conversations associated with an organization in Help Scout. Use when you need to retrieve all conversations linked to a specific organization. Returns paginated results with HAL+JSON format.

Parámetros de entrada

pageinteger
Page number for pagination (starts at 1)
organizationIdintegerObligatorio
The organization ID for retrieving associated conversations

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization CustomersHELP_SCOUT_GET_ORGANIZATION_CUSTOMERSAcción

Tool to get customers associated with an organization in Help Scout. Use when you need to retrieve a list of all customers belonging to a specific organization. Returns paginated results with 50 customers per page.

Parámetros de entrada

pageinteger
Page number for pagination (1-based indexing)
organization_idintegerObligatorio
The organization identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization PropertyHELP_SCOUT_GET_ORGANIZATION_PROPERTYAcción

Tool to retrieve a single organization property definition by its slug identifier. Use when you need to get details about a specific custom property configured for organizations, including its type, display name, and available options.

Parámetros de entrada

slugstringObligatorio
Property definition's unique slug identifier. This is the key used to identify the property in the API.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Organization PropertyHELP_SCOUT_GET_ORG_PROPERTYAcción

Tool to retrieve an organization property definition by its slug. Use when you need to view details of a custom property like its type, display name, and available options for dropdowns.

Parámetros de entrada

property_idstringObligatorio
The property definition identifier (slug) to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Phone ReportHELP_SCOUT_GET_PHONE_REPORTAcción

Tool to retrieve phone report statistics from Help Scout. Returns metrics like phone conversations, phone calls created, and customer counts for a specified period. Use when you need to analyze phone support performance or track phone activity trends. Note: Only available to Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required parameter.
tagsstring
Comma-separated list of tag IDs to filter the report. Example: '99787' or '5666,99787'.
startstringObligatorio
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required parameter.
foldersstring
Comma-separated list of folder IDs to filter the report. Example: '991' or '991,992'.
mailboxesstring
Comma-separated list of mailbox/inbox IDs to filter the report. Example: '123' or '123,567'.
officeHoursboolean
Whether to take office hours into consideration in the report calculations. Defaults to false if not specified.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. If provided, previousStart must also be specified.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. If provided, previousEnd must also be specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Productivity ReportHELP_SCOUT_GET_PRODUCTIVITY_REPORTAcción

Tool to retrieve productivity overall report showing comprehensive team performance metrics. Use when you need to analyze productivity statistics including response times, resolution times, handle times, and conversation volumes. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
officeHoursboolean
Whether to take office hours into consideration. Set to true to filter by office hours. Office hours must be enabled to use this filter.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Received Messages ReportHELP_SCOUT_GET_RECEIVED_MESSAGES_REPORTAcción

Tool to retrieve received messages statistics report from Help Scout. Returns count of customer-originated messages over time, broken down by day, week, or month. Use when you need to analyze incoming message volume trends or compare message counts across different time periods.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required.
tagsstring
Comma-separated list of tag IDs to filter the report. Optional.
startstringObligatorio
Start of the reporting interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
viewBystringenum
Enumeration for data resolution view types.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter the report. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Optional.
previousEndstring
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Replies Sent ReportHELP_SCOUT_GET_REPLIES_SENT_REPORTAcción

Tool to get replies sent productivity report showing reply volume metrics over time. Use when you need to analyze reply activity trends, compare periods, or track team productivity. Requires Plus or Pro plan.

Parámetros de entrada

endstringObligatorio
End date in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter by. Example: '5666,99787'
startstringObligatorio
Start date in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter by. Allowed values: 'email', 'chat', 'phone'
viewBystring
Data granularity for the report. Allowed values: 'day' (for periods ≤60 days), 'week' (for periods ≤1 year), 'month' (for periods ≥61 days)
foldersstring
Comma-separated list of folder IDs to filter by. Example: '991,992'
mailboxesstring
Comma-separated list of mailbox IDs to filter by. Example: '123,567'
officeHoursboolean
Apply office hours consideration. Set to true to include only replies during office hours, false for outside office hours.
previousEndstring
Previous period end date for comparison in ISO 8601 format. Example: '2023-12-31T23:59:59Z'
previousStartstring
Previous period start date for comparison in ISO 8601 format. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resolution Time ReportHELP_SCOUT_GET_RESOLUTION_TIME_REPORTAcción

Tool to retrieve resolution time productivity report showing average time to resolve conversations. Use when you need to analyze team resolution performance, track resolution time trends, or compare resolution times across different periods. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
viewBystringenum
Data resolution options for viewing report data.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
officeHoursboolean
Whether to take office hours into consideration. Set to true to filter by office hours. Office hours must be enabled to use this filter.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resolved ReportHELP_SCOUT_GET_RESOLVED_REPORTAcción

Tool to retrieve productivity resolved report from Help Scout. Returns the number of resolved conversations over time for a specified period. Use when you need to analyze team productivity, track resolution rates, or generate reports on conversation closures.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required.
tagsstring
Comma-separated list of tag IDs to filter the report. Optional.
startstringObligatorio
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
viewBystring
Data granularity for the report. Valid values: 'day' (for periods up to 60 days), 'week' (for periods up to 1 year), 'month' (for periods of 61 days or more). Optional.
foldersstring
Comma-separated list of folder IDs to filter the report. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Optional.
officeHoursboolean
Whether to apply office hours calculations. Defaults to false if not provided. Optional.
previousEndstring
Conclusion point for prior period comparison in ISO 8601 format. Optional.
previousStartstring
Beginning point for prior period comparison in ISO 8601 format. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Resource OwnerHELP_SCOUT_GET_RESOURCE_OWNERAcción

Tool to get the authenticated user's profile information. Use when you need to retrieve details about the current user.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Routing ConfigurationHELP_SCOUT_GET_ROUTING_CONFIGAcción

Tool to retrieve routing configuration for a mailbox inbox. Use when you need to check assignment settings, rotation status, or user eligibility for receiving conversations.

Parámetros de entrada

mailbox_idstringObligatorio
Unique identifier for the mailbox to retrieve routing configuration

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Saved ReplyHELP_SCOUT_GET_SAVED_REPLYAcción

Tool to retrieve a specific saved reply from a mailbox. Use when you need to get details about a saved reply template including its text content for email and chat.

Parámetros de entrada

mailbox_idstringObligatorio
The mailbox identifier containing the saved reply.
saved_reply_idstringObligatorio
The unique identifier for the saved reply to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get TagHELP_SCOUT_GET_TAGAcción

Tool to retrieve a specific tag by ID from Help Scout. Use when you need to get details about a tag including its name, slug, and color.

Parámetros de entrada

tag_idintegerObligatorio
The unique identifier for the tag to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get UserHELP_SCOUT_GET_USERAcción

Tool to retrieve a specific user by ID from Help Scout. Use when you need detailed information about a user including their role, contact details, and profile data.

Parámetros de entrada

user_idintegerObligatorio
Unique identifier for the user to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Chat ReportHELP_SCOUT_GET_USER_CHAT_REPORTAcción

Tool to retrieve user/team chat report statistics from Help Scout. Returns metrics like new conversations, messages per chat, response time, wait time, and duration for a specified period. Use when you need to analyze chat support performance or track chat activity trends for a specific user or team.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required parameter.
tagsstring
Comma-separated list of tag IDs to filter the report. Example: '99787' or '5666,99787'.
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required parameter.
mailboxesstring
Comma-separated list of mailbox/inbox IDs to filter the report. Example: '123' or '123,567'.
officeHoursboolean
Whether to take office hours into consideration in the report calculations. Defaults to false if not specified.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. If provided, previousStart must also be specified.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. If provided, previousEnd must also be specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Conversation HistoryHELP_SCOUT_GET_USER_CONVERSATION_HISTORYAcción

Tool to retrieve detailed conversation history for a specific user over a designated timeframe. Use when you need to analyze a user's conversation performance, track response times, or review conversation details. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'. Required.
pageinteger
Page number for pagination. Default is 1.
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
userintegerObligatorio
Identifier for the user generating the report. Required.
startstringObligatorio
Start of the reporting interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
statusstringenum
Status filter options for conversation history.
activependingclosed
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
sortFieldstringenum
Sort field options for conversation history.
numberrepliesSentresponseTimeresolveTime
sortOrderstringenum
Sort order options.
ASCDESC
officeHoursboolean
Apply office hours calculation. Set to true to include only conversations during office hours, false for outside office hours.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Customers Helped ReportHELP_SCOUT_GET_USER_CUSTOMERS_HELPED_REPORTAcción

Tool to retrieve user customers helped report showing distinct customer count receiving support from a specific user. Use when you need to analyze how many unique customers were helped by an individual team member during a specific period, compare periods, or track user performance. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
Conclusion of the time interval in ISO 8601 format. Example: '2026-03-09T23:59:59Z'. Required.
tagsstring
Comma-separated list of tag IDs for filtering. Example: '111,222,333'
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Beginning of the time interval in ISO 8601 format. Example: '2026-02-07T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone.
viewBystringenum
Data resolution options for viewing report data.
dayweekmonth
foldersstring
Comma-separated list of folder IDs for filtering. Example: '10,20,30'
mailboxesstring
Comma-separated list of mailbox/inbox IDs for filtering. Example: '123,456,789'
previousEndstring
Conclusion of comparison period in ISO 8601 format. If provided, previousStart must also be provided.
previousStartstring
Beginning of comparison period in ISO 8601 format. If provided, previousEnd must also be provided.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Drilldown ReportHELP_SCOUT_GET_USER_DRILLDOWNAcción

Tool to get user drilldown report from Help Scout. Use when you need detailed conversation data for a specific user within a time period. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format
pageinteger
Page number for pagination (default: 1)
rowsinteger
Number of results per page (default: 25, max: 50)
tagsstring
Comma-separated list of tag IDs to filter results
userintegerObligatorio
User ID for whom the report is generated
startstringObligatorio
Start of the interval in ISO 8601 format
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone
foldersstring
Comma-separated list of folder IDs to filter results
mailboxesstring
Comma-separated list of inbox IDs to filter results

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Happiness ReportHELP_SCOUT_GET_USER_HAPPINESS_REPORTAcción

Tool to retrieve user happiness report from Help Scout. Returns customer satisfaction metrics for a specific user including ratings percentages, counts, and happiness scores for a specified time period. Use when you need to analyze individual user performance on customer satisfaction.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'. Required.
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Ratings ReportHELP_SCOUT_GET_USER_RATINGS_REPORTAcción

Tool to retrieve user happiness ratings drilldown report showing customer satisfaction ratings for a specific user. Use when you need to analyze customer feedback, track happiness scores, or review rating comments for an individual support team member. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'. Required.
pageinteger
Page number for pagination. Default is 1.
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
ratingstringenum
Rating filter options.
greatokallnot-good
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
sortFieldstringenum
Sort field options for user ratings report.
numberrepliesSentresolveTimeresponseTime
sortOrderstringenum
Sort order options.
ASCDESC
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Replies ReportHELP_SCOUT_GET_USER_REPLIES_REPORTAcción

Tool to retrieve user replies report showing the number of replies sent by a specific user over time. Use when you need to analyze reply volume, track user productivity, or compare reply patterns across different time periods. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'. Required.
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'. Optional.
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'. Optional.
viewBystringenum
Data resolution options for user replies report.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'. Optional.
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'. Optional.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User ReportHELP_SCOUT_GET_USER_REPORTAcción

Tool to retrieve overall user/team performance report from Help Scout. Returns detailed metrics including conversations resolved, response time, happiness score, and customer interactions for a specific user. Use when analyzing individual team member performance or generating user-specific reports. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the reporting interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required.
tagsstring
Comma-separated list of tag IDs to filter the report. Optional.
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the reporting interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required.
typesstring
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
foldersstring
Comma-separated list of folder IDs to filter the report. Optional.
mailboxesstring
Comma-separated list of inbox IDs to filter the report. Optional.
officeHoursboolean
Whether to consider office hours in the report. Defaults to false if not provided. Optional.
previousEndstring
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
previousStartstring
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User Resolutions ReportHELP_SCOUT_GET_USER_RESOLUTIONS_REPORTAcción

Tool to retrieve user resolutions report showing the number of conversations resolved by a specific user over time. Use when you need to analyze resolution trends, track individual performance, or compare resolution rates across different time periods. Available only for Plus and Pro plans.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format. Example: '2024-01-31T23:59:59Z'. Required.
tagsstring
Comma-separated list of tag IDs to filter results. Example: '10,20,30'
userintegerObligatorio
User ID for whom the report is generated. Required.
startstringObligatorio
Start of the interval in ISO 8601 format. Example: '2024-01-01T00:00:00Z'. Required.
typesstring
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: 'email,chat'
viewBystringenum
Granularity options for viewing resolution data.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter results. Example: '100,200'
mailboxesstring
Comma-separated list of inbox IDs to filter results. Example: '123,456,789'
previousEndstring
End of the previous interval in ISO 8601 format for comparison. Example: '2023-12-31T23:59:59Z'
previousStartstring
Start of the previous interval in ISO 8601 format for comparison. Example: '2023-12-01T00:00:00Z'

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get User StatusHELP_SCOUT_GET_USER_STATUSAcción

Tool to get the status of a user in Help Scout. Use when you need to check a user's email availability (active/away) or chat status across mailboxes.

Parámetros de entrada

user_idintegerObligatorio
The unique identifier of the user whose status to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Volume by Channel ReportHELP_SCOUT_GET_VOLUME_BY_CHANNEL_REPORTAcción

Tool to retrieve conversation volume by channel (email, chat, phone) over a specified time period. Use when you need to analyze conversation volume trends across different communication channels. Requires Help Scout Plus or Pro plan.

Parámetros de entrada

endstringObligatorio
End of the interval in ISO 8601 format (e.g., '2024-01-31T23:59:59Z'). Required parameter for the report date range.
tagsstring
Comma-separated list of tag IDs to filter results. Only includes conversations with specified tags.
startstringObligatorio
Start of the interval in ISO 8601 format (e.g., '2024-01-01T00:00:00Z'). Required parameter for the report date range.
typesstring
Comma-separated list of conversation types to include. Valid values: email, chat, phone. If not specified, all types are included.
viewBystringenum
Data resolution period options.
dayweekmonth
foldersstring
Comma-separated list of folder IDs to filter results. Only includes conversations from specified folders.
mailboxesstring
Comma-separated list of mailbox IDs to filter results. Only includes conversations from specified mailboxes.
previousEndstring
Ending date for comparison period in ISO 8601 format. When provided with previousStart, enables comparison with a previous time period.
previousStartstring
Beginning date for comparison period in ISO 8601 format. When provided with previousEnd, enables comparison with a previous time period.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get WebhookHELP_SCOUT_GET_WEBHOOKAcción

Tool to retrieve a specific webhook by ID from Help Scout. Use when you need to view webhook configuration details including URL, events, state, and other settings.

Parámetros de entrada

webhook_idintegerObligatorio
The unique identifier of the webhook to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Chat HandlesHELP_SCOUT_LIST_CHAT_HANDLESAcción

Tool to list all chat handles for a specific customer in Help Scout. Use when you need to retrieve chat service accounts (Skype, AIM, ICQ, etc.) associated with a customer.

Parámetros de entrada

customer_idintegerObligatorio
Unique identifier for the customer whose chat handles to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ConversationsHELP_SCOUT_LIST_CONVERSATIONSAcción

Tool to list and filter conversations from Help Scout. Use when you need to retrieve multiple conversations, search by status/tags/assignee, or access conversations modified since a specific date. Returns paginated results with conversation details including subject, status, customer info, and tags. Use the thread resource link inside each Conversation entity to load conversation threads separately.

Parámetros de entrada

tagstring
Filter by tag name. Returns conversations tagged with the specified tag.
pageinteger
Page number for pagination. Use to retrieve subsequent pages of results.
querystring
Search query using Mailbox API query syntax. Allows complex filtering with operators like AND, OR, NOT.
numberinteger
Filter by conversation number. Returns the conversation with this specific number.
statusstringenum
Conversation status values.
activeallclosedopenpendingspam
mailboxinteger
Filter by mailbox ID. Returns conversations from the specified mailbox only.
sortFieldstringenum
Sort field options for conversations.
createdAtcustomerEmailcustomerNamemailboxidmodifiedAtnumberscorestatussubject
sortOrderstringenum
Sort order options.
ascdesc
assigned_tointeger
Filter by assigned user ID. Returns conversations assigned to the specified user.
modifiedSincestring
Filter by modification date. Returns conversations modified since this ISO 8601 timestamp.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Customer EmailsHELP_SCOUT_LIST_CUSTOMER_EMAILSAcción

Tool to list all emails for a specific customer in Help Scout. Use when you need to retrieve all email addresses associated with a customer profile.

Parámetros de entrada

customer_idintegerObligatorio
Unique identifier for the customer whose emails to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Customer PhonesHELP_SCOUT_LIST_CUSTOMER_PHONESAcción

Tool to list all phone numbers for a specific Help Scout customer. Use when you need to retrieve the phone contact information for a customer.

Parámetros de entrada

customer_idintegerObligatorio
The unique identifier of the customer whose phones to retrieve

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Customer PropertiesHELP_SCOUT_LIST_CUSTOMER_PROPERTIESAcción

Tool to list all customer property definitions. Use when you need to view all custom properties configured for customers in the Help Scout account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List CustomersHELP_SCOUT_LIST_CUSTOMERSAcción

Tool to list customers in Help Scout with optional filters for name, email, or modification date. Use when you need to retrieve a list of customers, search for specific customers, or get customers modified since a certain date. Returns paginated results.

Parámetros de entrada

pageinteger
Page number for pagination (starts at 1)
emailstring
Filter customers by email address
lastNamestring
Filter customers by last name
firstNamestring
Filter customers by first name
modifiedSincestring
Filter customers modified since this date in ISO 8601 format

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Customer WebsitesHELP_SCOUT_LIST_CUSTOMER_WEBSITESAcción

Tool to list all websites associated with a specific customer in Help Scout. Use when you need to retrieve all website URLs linked to a customer profile.

Parámetros de entrada

customer_idintegerObligatorio
Unique customer identifier to retrieve websites for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Inbox Custom FieldsHELP_SCOUT_LIST_INBOX_CUSTOM_FIELDSAcción

Tool to list all custom fields configured for a specific inbox. Use when you need to retrieve custom field definitions including field types, options, and display order.

Parámetros de entrada

mailbox_idstringObligatorio
Unique identifier for the mailbox to retrieve custom fields from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List InboxesHELP_SCOUT_LIST_INBOXESAcción

Tool to list all mailboxes (inboxes) the user has access to with pagination support. Use when you need to retrieve a list of all available inboxes or mailboxes.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1 if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Inbox FoldersHELP_SCOUT_LIST_INBOX_FOLDERSAcción

Tool to retrieve all folders within a specific inbox/mailbox. Use when you need to list folders for organizing conversations or access folder details like ticket counts.

Parámetros de entrada

mailbox_idstringObligatorio
Unique identifier for the mailbox to retrieve folders from

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List OrganizationsHELP_SCOUT_LIST_ORGANIZATIONSAcción

Tool to list all organizations (companies) in Help Scout with optional filtering and sorting. Use when you need to retrieve a list of organizations, search for specific organizations by name, or get paginated organization results.

Parámetros de entrada

namestring
Filter organizations by name. Performs a partial match search.
pageinteger
Page number for pagination (starts at 1). Default is 1.
sortFieldstringenum
Sort field options for organizations.
namecreatedAtmodifiedAt
sortOrderstringenum
Sort order options.
ascdesc

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Organizations PropertiesHELP_SCOUT_LIST_ORGANIZATIONS_PROPERTIESAcción

Tool to list all organization property definitions. Use when you need to view all custom properties configured for organizations in the Help Scout account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Saved RepliesHELP_SCOUT_LIST_SAVED_REPLIESAcción

Tool to list saved replies for a mailbox. Use when you need to retrieve all saved reply templates available in a specific mailbox.

Parámetros de entrada

mailbox_idstringObligatorio
The mailbox identifier to list saved replies from.
includeChatRepliesboolean
Should all saved replies (also chat-only) be included in response? Defaults to false if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Social ProfilesHELP_SCOUT_LIST_SOCIAL_PROFILESAcción

Tool to list all social profiles for a customer in Help Scout. Use when you need to retrieve a customer's social media profile information (LinkedIn, Twitter, Facebook, etc.).

Parámetros de entrada

customerIdintegerObligatorio
The unique identifier of the customer whose social profiles to retrieve.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TagsHELP_SCOUT_LIST_TAGSAcción

Tool to list all tags in Help Scout with pagination support. Use when you need to retrieve all available tags in alphabetical order. Returns tag details including name, color, and ticket count.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1 if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List TeamsHELP_SCOUT_LIST_TEAMSAcción

Tool to list all teams in Help Scout with pagination support. Use when you need to retrieve a list of all available teams.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1 if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List ThreadsHELP_SCOUT_LIST_THREADSAcción

Tool to list all threads for a specific Help Scout conversation. Use when you need to retrieve the complete message history and interactions within a conversation. Threads are sorted by createdAt from newest to oldest by default.

Parámetros de entrada

conversation_idintegerObligatorio
The unique conversation identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List UsersHELP_SCOUT_LIST_USERSAcción

Tool to list all users in the Help Scout account with optional filters for mailbox or email. Use when you need to retrieve a list of team members, check user roles, or find users by email or mailbox assignment.

Parámetros de entrada

pageinteger
Page number for pagination (starts at 1)
emailstring
Filter users by email address to find a specific user
mailboxinteger
Filter users by mailbox ID to get only users assigned to that mailbox

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List Users StatusHELP_SCOUT_LIST_USERS_STATUSAcción

Tool to list the status of all users including email and chat availability. Use when you need to check which users are currently active, away, or available for different channels.

Parámetros de entrada

pageinteger
Page number for pagination. Defaults to 1 if not specified.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List User StatusesHELP_SCOUT_LIST_USER_STATUSESAcción

Tool to list availability statuses for all users in Help Scout. Use when you need to check user availability for email and chat across the organization.

Parámetros de entrada

pageinteger
Page number for pagination (optional)

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WebhooksHELP_SCOUT_LIST_WEBHOOKSAcción

Tool to retrieve all webhooks configured in Help Scout. Use when you need to view all webhook subscriptions and their configurations.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

List WorkflowsHELP_SCOUT_LIST_WORKFLOWSAcción

Tool to list all workflows (automation rules) in the account with optional filters for mailbox, type, and status. Use when you need to retrieve workflows to view automation rules configured in Help Scout.

Parámetros de entrada

pageinteger
Page number for pagination (starts at 1)
typestringenum
Workflow type enumeration.
automaticmanual
statusstringenum
Workflow status enumeration.
activeinactiveinvalid
mailboxinteger
Filter workflows by mailbox ID

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Overwrite CustomerHELP_SCOUT_OVERWRITE_CUSTOMERAcción

Tool to overwrite an existing customer in Help Scout, replacing all customer data. Use when you need to completely replace a customer's profile information. Fields not provided in the request will be set to null, effectively removing them.

Parámetros de entrada

agestring
Age or age range descriptor. If not provided, will be set to null.
phonestring
Phone number for the customer. Used when creating new customer.
genderstringenum
Gender enumeration for customer profiles.
malefemaleunknown
jobTitlestring
Job title (max 60 characters). If not provided, will be set to null.
lastNamestring
Customer's last name (1-40 characters). If not provided, will be set to null.
locationstring
Customer's location (max 60 characters). If not provided, will be set to null.
photoUrlstring
URL to profile photo (max 200 characters). If not provided, will be set to null.
firstNamestring
Customer's first name (1-40 characters). If not provided, will be set to null.
photoTypestringenum
Photo type enumeration for customer profile photos.
unknowngravatartwitterfacebookgoogleprofilegooglepluslinkedininstagram
backgroundstring
Background information or notes from the user interface (max 200 characters). If not provided, will be set to null.
customerIdintegerObligatorio
Unique customer identifier to overwrite
organizationstring
Organization name (max 60 characters). DEPRECATED: use organizationId instead. If not provided, will be set to null.
organizationIdinteger
Organization ID reference. If not provided, will be set to null.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Publish Thread ScheduleHELP_SCOUT_PUBLISH_THREAD_SCHEDULEAcción

Tool to publish a scheduled thread immediately in a Help Scout conversation. Use when you need to send a scheduled message sooner than originally planned. The draft thread is turned into a reply/forward thread and the message is sent to the customer immediately.

Parámetros de entrada

thread_idintegerObligatorio
The unique identifier of the scheduled thread to publish immediately
conversation_idintegerObligatorio
The unique identifier of the conversation containing the scheduled thread

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove Organization Property ValueHELP_SCOUT_REMOVE_ORGANIZATION_PROPERTY_VALUEAcción

Tool to remove an organization property value. Use when clearing the value of a custom property for a specific organization. The property definition itself is not deleted, only its value for this organization is cleared.

Parámetros de entrada

slugstringObligatorio
Property definition's unique slug identifier. This is the key used to identify the property in the API.
organization_idintegerObligatorio
The organization's unique identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Run Manual WorkflowHELP_SCOUT_RUN_MANUAL_WORKFLOWAcción

Tool to run a manual workflow on one or more conversations in Help Scout. Use when you need to execute workflow actions on specific conversations. Only manual workflows can be executed via this action, and all conversation IDs must be from the same inbox as the workflow.

Parámetros de entrada

workflowIdintegerObligatorio
The identifier of the manual workflow to execute
conversationIdsinteger[]Obligatorio
An array of conversation IDs to apply the workflow to. The workflow actions will be applied to each conversation. Maximum of 50 IDs per request. All conversation IDs must belong to existing conversations and be from the same inbox as the workflow.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set Organization Property ValueHELP_SCOUT_SET_ORGANIZATION_PROPERTY_VALUEAcción

Tool to set or update a property value for a specific organization. Use when you need to assign a value to a custom property field on an organization, such as setting their tier, industry, or other metadata.

Parámetros de entrada

slugstringObligatorio
Property definition's unique slug identifier. This is the key used to identify the property in the API.
valuestringObligatorio
The property value formatted as a string. Format requirements vary by property type: text/URL (plain string), number ('100'), date ('2024-01-15' in ISO 8601 format), dropdown (option label). If a property already has a value, it will be replaced with this new value.
organization_idintegerObligatorio
Unique identifier of the organization to set the property value for

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Set User StatusHELP_SCOUT_SET_USER_STATUSAcción

Tool to set the status of a user in Help Scout. Use when you need to change a user's availability to 'active' or 'away'. Administrators and Account Owners can edit other users' status.

Parámetros de entrada

statusstringObligatorioenum
The status to set for the user: 'active' (available) or 'away' (unavailable)
activeaway
user_idintegerObligatorio
The unique identifier of the user whose status to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Chat HandleHELP_SCOUT_UPDATE_CHAT_HANDLEAcción

Tool to update a chat handle for a Help Scout customer. Use when you need to modify an existing chat platform username (like Skype, AIM, Yahoo) associated with a customer's profile.

Parámetros de entrada

typestringObligatorioenum
Chat platform type. Must be one of: aim, gtalk, icq, msn, other, qq, skype, xmpp, yahoo
aimgtalkicqmsnotherqqskypexmppyahoo
valuestringObligatorio
The updated chat handle/username on the specified platform
customerIdintegerObligatorio
The customer ID whose chat handle to update
chatHandleIdintegerObligatorio
The chat handle ID to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ConversationHELP_SCOUT_UPDATE_CONVERSATIONAcción

Tool to update specific properties of a Help Scout conversation using JSON Patch format. Use when you need to modify conversation subject, status, assignment, mailbox, primary customer, or draft status. Each request updates one field at a time.

Parámetros de entrada

opstringObligatorioenum
JSON Patch operation: add, move, remove, or replace
addmoveremovereplace
pathstringObligatorio
Field path to update. Valid paths: /subject (string), /primaryCustomer.id (number), /draft (boolean), /mailboxId (number, use 'move' op), /status (string: active/closed/pending/spam), /assignTo (number, supports 'remove' to unassign)
valueany
New value for the field. Required for add/replace/move operations, omit for remove operation. Type depends on path: string for subject/status, number for primaryCustomer.id/mailboxId/assignTo, boolean for draft
conversation_idintegerObligatorio
The unique identifier of the conversation to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Conversation TagsHELP_SCOUT_UPDATE_CONVERSATION_TAGSAcción

Tool to update tags on a conversation in Help Scout. Use when you need to add, remove, or replace tags on a conversation. This operation replaces the entire tag set - any existing tags not included will be removed.

Parámetros de entrada

tagsstring[]Obligatorio
Complete list of tag names to apply to the conversation. This replaces all existing tags - tags not in this list will be removed. Non-existent tags are created automatically. To remove all tags, pass an empty array
conversation_idintegerObligatorio
Unique identifier for the conversation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Conversation Thread ScheduleHELP_SCOUT_UPDATE_CONVERSATION_THREAD_SCHEDULEAcción

Tool to update an existing schedule for a conversation thread in Help Scout. Use when you need to change when a reply or forward thread should be sent. Subsequent requests override previous schedules for the same thread.

Parámetros de entrada

thread_idintegerObligatorio
Identifier for the thread to schedule
scheduledForstringObligatorio
ISO 8601 date string in the future when the thread should be sent. Must not be after year 2100.
sendAsCreatorboolean
Whether the reply should be sent as the draft's original creator. Defaults to false.
conversation_idintegerObligatorio
Identifier for the conversation containing the thread
unscheduleOnCustomerReplybooleanObligatorio
Determines if a new customer reply should unschedule the thread

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update CustomerHELP_SCOUT_UPDATE_CUSTOMERAcción

Tool to update an existing customer in Help Scout using JSON Patch operations. Use when you need to modify specific customer fields without replacing the entire record. Supports updating profile fields, address, and collections (emails, phones, etc.).

Parámetros de entrada

operationsobject[]Obligatorio
Array of JSON Patch operations to apply. Each operation must specify op (add/replace/remove), path (field to modify), and value (for add/replace ops). Supports fields: firstName, lastName, age, gender, jobTitle, location, organization, background, photoUrl, photoType, address fields, and collections (emails, phones, chats, social-profiles, websites).
customer_idintegerObligatorio
Unique customer identifier to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer AddressHELP_SCOUT_UPDATE_CUSTOMER_ADDRESSAcción

Tool to update an existing address for a Help Scout customer. Use when you need to modify a customer's physical address.

Parámetros de entrada

citystringObligatorio
City of the address.
linesstring[]
Address lines (street address, building number, etc.).
statestringObligatorio
State or province of the address.
countrystringObligatorio
Country code of the address (typically 2-letter ISO code).
customer_idintegerObligatorio
The unique identifier for the customer.
postal_codestringObligatorio
Postal code or ZIP code of the address.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer Chat HandleHELP_SCOUT_UPDATE_CUSTOMER_CHATAcción

Tool to update an existing chat handle for a customer in Help Scout. Use when you need to modify a customer's instant messaging account (Skype, AIM, ICQ, etc.).

Parámetros de entrada

typestringObligatorioenum
Chat service type - one of: aim, gtalk, icq, msn, other, qq, skype, xmpp, yahoo
aimgtalkicqmsnotherqqskypexmppyahoo
valuestringObligatorio
The chat handle/username for the specified platform
chat_idintegerObligatorio
Unique identifier for the chat handle to update
customer_idintegerObligatorio
Unique identifier for the customer whose chat handle to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update customer emailHELP_SCOUT_UPDATE_CUSTOMER_EMAILAcción

Tool to update an existing email for a customer in Help Scout. Use when you need to modify a customer's email address or change its type (home/work/other).

Parámetros de entrada

typestringObligatorioenum
Email category - home, other, or work
homeotherwork
valuestringObligatorio
Updated email address for the customer
entry_idstringObligatorio
Identifier of the email entry to update
customer_idstringObligatorio
Identifier of the customer whose email to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer PhoneHELP_SCOUT_UPDATE_CUSTOMER_PHONEAcción

Tool to update an existing phone number for a Help Scout customer. Use when modifying phone number details or type for a customer's profile.

Parámetros de entrada

typestringObligatorioenum
Phone location type. Must be one of: fax, home, mobile, other, pager, work
faxhomemobileotherpagerwork
valuestringObligatorio
The updated telephone number
phone_idintegerObligatorio
The unique identifier for the phone number to update
customer_idintegerObligatorio
The unique identifier for the customer whose phone should be updated

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer PropertiesHELP_SCOUT_UPDATE_CUSTOMER_PROPERTIESAcción

Tool to update custom property values for a Help Scout customer using JSON Patch operations. Use when you need to modify existing property values like subscription plan, tier level, or custom attributes. Properties must be created first before updating values.

Parámetros de entrada

customerIdintegerObligatorio
The unique identifier of the customer whose properties to update
operationsobject[]Obligatorio
Array of JSON Patch operations to apply to the customer's properties. Each operation modifies a single property. Properties must be created first via the Create Property endpoint or web UI

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer Social ProfileHELP_SCOUT_UPDATE_CUSTOMER_SOCIAL_PROFILEAcción

Tool to update an existing social profile for a customer in Help Scout. Use when you need to modify a customer's social media profile URL or handle, or change its type.

Parámetros de entrada

typestringObligatorioenum
The type of social profile (e.g., twitter, facebook, linkedin, etc.).
aboutmefacebookflickrforsquaregooglegooglepluslinkedinotherquoratunglemetwitteryoutube
valuestringObligatorio
The social profile URL or handle. For URLs, provide the full URL (e.g., 'https://twitter.com/testuser'). For handles, provide the username.
customerIdintegerObligatorio
The unique identifier of the customer who owns the social profile.
socialProfileIdintegerObligatorio
The unique identifier of the social profile to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Customer WebsiteHELP_SCOUT_UPDATE_CUSTOMER_WEBSITEAcción

Tool to update an existing website URL for a customer in Help Scout. Use when modifying a website entry on a customer's profile.

Parámetros de entrada

valuestringObligatorio
The updated website URL
website_idintegerObligatorio
The ID of the website entry to update
customer_idintegerObligatorio
The ID of the customer whose website to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Custom FieldsHELP_SCOUT_UPDATE_CUSTOM_FIELDSAcción

Tool to update custom fields on a Help Scout conversation. The complete fields list replaces existing data—omitted fields are removed. Use when you need to set or clear custom field values on a conversation.

Parámetros de entrada

fieldsobject[]Obligatorio
List of custom fields to be applied to the conversation. Complete list replaces existing data—omitted fields are removed. Empty array clears all custom fields.
conversation_idintegerObligatorio
The unique conversation identifier

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Mailbox Routing ConfigurationHELP_SCOUT_UPDATE_MAILBOXES_ROUTINGAcción

Tool to update routing configuration for a mailbox inbox in Help Scout. Use when you need to enable/disable routing, change assignment limits, modify assignment strategy, or update the list of users in rotation.

Parámetros de entrada

statestringObligatorioenum
Routing configuration state - 'enabled' or 'disabled'
enableddisabled
userIdsinteger[]Obligatorio
List of user IDs to include in the rotation. Must not be empty when routing state is 'enabled'. Users must be active and have access to the mailbox.
mailbox_idstringObligatorio
Unique identifier for the mailbox to update routing configuration
assignmentLimitintegerObligatorio
Maximum number of conversations that can be assigned (range: 1-100)
assignmentMethodstringObligatorioenum
Assignment strategy for distributing conversations - 'round_robin' assigns to users in sequence, 'balanced' assigns to users with fewest active conversations
round_robinbalanced

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update OrganizationHELP_SCOUT_UPDATE_ORGANIZATIONAcción

Tool to update an organization in Help Scout. Use when you need to modify organization details such as name, website, domains, or contact information. This is a complete update operation - provide all fields to avoid removal of existing data.

Parámetros de entrada

namestringObligatorio
Organization name (required). This is a complete update - all required fields must be provided.
notestring
Internal notes about the organization (visible only to team members). Omitting this will clear the note.
phonesstring[]Obligatorio
Array of phone numbers associated with the organization (required). Provide empty array if no phones.
domainsstring[]Obligatorio
Array of domain strings associated with the organization (required). Provide empty array if no domains.
websitestringObligatorio
Organization website URL (required). This is a complete update - all required fields must be provided.
locationstring
Physical location of the organization. Omitting this will clear the location.
brandColorstring
Brand color in hex format (e.g., #fefefe). Omitting this will clear the brand color.
descriptionstring
Description of the organization. Omitting this will clear the description.
organization_idintegerObligatorio
The unique identifier for the organization to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Organization PropertyHELP_SCOUT_UPDATE_ORGANIZATION_PROPERTYAcción

Tool to update an organization property definition in Help Scout. Use when you need to modify the name or options of an existing custom property. Note: Property type and slug cannot be changed after creation.

Parámetros de entrada

namestringObligatorio
Updated name of the property; maximum 100 characters
slugstringObligatorio
The identifier for the organization property being updated. This is the property's unique slug.
optionsobject[]
The updated list of options for a dropdown property. Maximum 100 options. When provided, this completely replaces existing options. Note: Removing options will delete all property values for those options.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Organization Property IndustryHELP_SCOUT_UPDATE_ORGANIZATION_PROPERTY_INDUSTRYAcción

Tool to update the industry organization property definition in Help Scout. Use when you need to modify the display name or available dropdown options for the industry field. Note: updating options replaces the entire list and removed options cascade delete existing values.

Parámetros de entrada

namestringObligatorio
Updated display name for the industry property. Maximum 100 characters.
optionsobject[]
Updated list of industry options for the dropdown. Maximum 100 options. When provided, the entire options list is replaced - any removed options will cascade delete existing values.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Routing ConfigurationHELP_SCOUT_UPDATE_ROUTING_CONFIGAcción

Tool to update routing configuration for a mailbox inbox. Use when you need to enable/disable automatic conversation routing, set assignment limits, choose assignment method, or modify the user rotation list.

Parámetros de entrada

statestringObligatorioenum
Routing configuration state - set to 'enabled' to activate routing or 'disabled' to deactivate
enableddisabled
user_idsinteger[]Obligatorio
List of user IDs to include in the routing rotation. Must contain at least one user when state is enabled.
mailbox_idstringObligatorio
Unique identifier for the mailbox to update routing configuration
assignment_limitintegerObligatorio
Maximum number of conversations that can be assigned to each user in the rotation. Must be between 1 and 100.
assignment_methodstringObligatorioenum
Method for assigning conversations: 'round_robin' distributes evenly in order, 'balanced' considers current workload
round_robinbalanced

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update saved replyHELP_SCOUT_UPDATE_SAVED_REPLYAcción

Tool to update an existing saved reply in a Help Scout mailbox. Use when you need to modify the name or content of a saved reply template.

Parámetros de entrada

namestringObligatorio
The name of the saved reply. This is used to identify and search for the reply.
textstring
The saved reply's text content for email messages. Supports HTML formatting with tags like <br /> for line breaks.
chatTextstring
The saved reply's text content for chat messages. Use plain text with newline characters (\n) for line breaks instead of HTML.
mailboxIdstringObligatorio
The mailbox ID where the saved reply exists. This identifies which mailbox the saved reply belongs to.
savedReplyIdstringObligatorio
The unique identifier of the saved reply to update.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Conversation SnoozeHELP_SCOUT_UPDATE_SNOOZEAcción

Tool to update or set a snooze on a Help Scout conversation. Use when you need to snooze a conversation until a specific date/time, optionally unsnoozing when the customer replies.

Parámetros de entrada

snoozed_untilstringObligatorio
ISO 8601 date string in the future when the conversation should be unsnoozed. Must not be after year 2100.
conversation_idintegerObligatorio
Unique identifier for the conversation to snooze
unsnooze_on_customer_replybooleanObligatorio
Whether a new customer response should automatically unsnooze the conversation

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update ThreadHELP_SCOUT_UPDATE_THREADAcción

Tool to update a specific thread in a Help Scout conversation using JSON Patch format. Use when you need to modify thread text content or hide/unhide a thread. Requires admin-level access or thread editing enabled for the account.

Parámetros de entrada

opstringObligatorioenum
JSON Patch operation type. Only 'replace' is supported for thread updates
replace
pathstringObligatorioenum
Field path to update. Valid paths: /text (modify thread text content), /hidden (hide/unhide thread - applies to non-draft customer or reply threads only)
/text/hidden
valueanyObligatorio
New value for the field. Use string for /text path (thread content), boolean for /hidden path (true to hide, false to unhide). Note: Original text is saved and viewable on Help Scout website
threadIdintegerObligatorio
The unique identifier of the thread to update
conversationIdintegerObligatorio
The unique identifier of the conversation containing the thread

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Thread ScheduleHELP_SCOUT_UPDATE_THREAD_SCHEDULEAcción

Tool to update the schedule for a thread in a Help Scout conversation. Use when you need to change when a draft reply will be sent or update scheduling behavior. The API returns 204 No Content on success.

Parámetros de entrada

thread_idintegerObligatorio
The unique thread identifier
scheduled_forstringObligatorio
ISO 8601 date string in the future when the thread should be sent. Must not be after year 2100.
conversation_idintegerObligatorio
The unique conversation identifier
send_as_creatorboolean
Boolean to send reply as original draft creator. Defaults to false if not specified.
unschedule_on_customer_replybooleanObligatorio
Boolean flag determining if customer responses cancel scheduling. If true, the scheduled thread will be unscheduled when a customer replies.

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update WebhookHELP_SCOUT_UPDATE_WEBHOOKAcción

Tool to update an existing webhook subscription in Help Scout. Use when modifying webhook configuration such as URL, events, secret, or other settings.

Parámetros de entrada

urlstringObligatorio
The callback URL where webhook events will be sent
labelstring
Label to identify the webhook
eventsstring[]Obligatorio
Array of event names to subscribe to for webhook notifications
secretstringObligatorio
Secret key for webhook signature verification (max 40 characters)
mailboxIdsinteger[]
Array of mailbox IDs to scope webhook to specific mailboxes. If omitted, webhook applies to all mailboxes
webhook_idintegerObligatorio
The unique identifier of the webhook to update
notificationboolean
If true, sends only resource URI instead of full payload
payloadVersionstringenum
Webhook payload version.
V2

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Update Workflow StatusHELP_SCOUT_UPDATE_WORKFLOW_STATUSAcción

Tool to update the status of a Help Scout workflow (enable/disable automation rule). Use when you need to activate or deactivate a workflow.

Parámetros de entrada

statusstringObligatorioenum
New status for the workflow: active to enable, inactive to disable
activeinactive
workflow_idintegerObligatorio
The unique identifier of the workflow to update

Parámetros de salida

dataobjectObligatorio
Data from the action execution
errorstring
Error if any occurred during the execution of the action
successfulbooleanObligatorio
Whether or not the action execution was successful or not