Skip to main content
Help Scout logo
  • Category: customer support
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 129
  • Triggers: 0
  • Slug: HELP_SCOUT
  • Version: 20261101_00

Tools

Slug: HELP_SCOUT_CREATE_CHAT_HANDLETool 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.

Input Parameters

string ("aim" | "gtalk" | "icq" | "msn" | "other" | "qq" | "skype" | "xmpp" | "yahoo")
required
Chat platform type. Must be one of: aim, gtalk, icq, msn, other, qq, skype, xmpp, yahoo
string
required
The chat handle/username on the specified platform
integer
required
The customer ID for whom to create the chat handle

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CHAT_THREADTool 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.

Input Parameters

string
required
The chat message content.
object
required
Customer details. Either customer.id or customer.email must be provided.
boolean
Set to true when importing historical data. Prevents notifications from being sent. Use for bulk imports or historical data migration.
string
Custom creation timestamp for imported threads. ISO 8601 format. Only used when imported=true.
array
List of file attachments to include with the chat thread.
integer
required
The ID of the conversation to create the chat thread on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CONVERSATIONTool to create a new conversation in Help Scout. Use when creating email, phone, or chat conversations with customer threads.

Input Parameters

array
Array of tag names to apply to the conversation
string ("email" | "phone" | "chat")
required
Conversation type: email, phone, or chat
integer
User ID of the user who created the conversation. Only valid for imported conversations
array
Array of custom field objects with id and value
string ("active" | "closed" | "pending" | "spam")
Conversation status: active, closed, pending, or spam
string
required
Subject line for the conversation
array
required
Array of thread objects. At least one thread is required to create a conversation
integer
User ID to assign the conversation to
string
Closed date in ISO 8601 format (e.g., 2024-01-15T12:00:00Z). Only valid when status is closed
object
required
Customer object with email or id. At least one must be provided
boolean
Set to true if this is an imported conversation. When true, no notifications are sent and the conversation is marked as imported
string
Created date in ISO 8601 format (e.g., 2024-01-15T10:30:00Z). Only valid for imported conversations
integer
required
ID of the mailbox where conversation will be created

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMERTool 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.

Input Parameters

string
Age or age range
array
Array of chat handle objects with type and value
array
Array of email objects with type and value. At least one email is recommended for customer identification.
string
Gender: male, female, or unknown
array
Array of phone objects with type and value
object
Address object with location details.
string
Job title (max 60 characters)
string
Customer’s last name (1-40 characters)
string
URL to profile photo (max 200 characters)
array
Array of website URLs
string
Customer’s first name (1-40 characters)
string
Background information or notes (max 200 characters)
string
Organization name
array
Array of social profile objects with type and value

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_ADDRESSTool to create an address for a Help Scout customer. Use when you need to add a physical address to a customer’s profile.

Input Parameters

string
required
City of the address.
array
Address lines (street address, building number, etc.).
string
required
State or province of the address.
string
required
Country code of the address (typically 2-letter ISO code).
integer
required
The unique identifier for the customer.
string
required
Postal code or ZIP code of the address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_EMAILTool 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.

Input Parameters

string ("home" | "other" | "work")
required
Email category - home, other, or work
string
required
Email address to add for the customer
string
required
Identifier of the customer to add the email to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_PHONETool to create a phone number for a Help Scout customer. Use when adding contact phone numbers to customer profiles.

Input Parameters

string ("fax" | "home" | "mobile" | "other" | "pager" | "work")
required
Phone location type (fax, home, mobile, other, pager, or work)
string
required
The telephone number
integer
required
The customer ID to add the phone number to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_PROPERTYTool 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.

Input Parameters

string
required
Human-readable display name for the property
string
required
Unique identifier for the property (1-100 characters, alphanumeric with hyphens/underscores only). Cannot be ‘email’, ‘name’, ‘company’, or ‘jobTitle’ as these are reserved
string ("number" | "text" | "url" | "date" | "dropdown")
required
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
array
List of dropdown options (max 100). Required when type is ‘dropdown’, ignored for other types. Each option must have a unique label

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_THREADTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_CUSTOMER_WEBSITECreate a website entry for an existing Help Scout customer by adding a URL to their profile. Returns the identifier of the newly created website.

Input Parameters

string
required
The website URL to add to the customer profile
integer
required
The ID of the customer to add the website to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_NOTETool 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.

Input Parameters

string
required
The note text content
integer
User ID adding the thread; defaults to resource owner if omitted
string ("active" | "closed" | "inbox_predefined" | "open" | "pending" | "spam")
Conversation status options.
boolean
Enables thread creation for historical purposes; prevents outgoing emails/notifications when true
string
Historical creation date in ISO 8601 format; only usable when imported is true
array
Optional list of attachment objects to include with the note
integer
required
The ID of the conversation to add the note to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_ORGANIZATIONTool to create a new organization in Help Scout. Use when you need to create a company profile with associated domains, contact information, and metadata.

Input Parameters

string
required
Organization name (required)
string
Internal notes about the organization (visible only to team members)
array
Array of phone numbers associated with the organization
array
Array of domain strings associated with the organization
string
Organization website URL
string
Physical location of the organization
string
Brand color in hex format (e.g., #FF5733)
string
Description of the organization

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_ORGANIZATION_PROPERTYTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_PHONE_THREADTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_REPLY_THREADTool 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.

Input Parameters

array
Array of CC email addresses
array
Array of BCC email addresses
string
required
Reply text content (HTML supported)
integer
required
Help Scout user ID sending the reply
boolean
When true, creates a draft reply instead of publishing immediately. Defaults to false
string ("active" | "closed" | "pending" | "spam" | "open" | "inbox_predefined")
Conversation status options.
integer
User ID to assign the conversation to after publishing the reply
object
required
Customer object with id field
boolean
Set to true for historical/imported replies. Prevents outgoing emails and notifications
string
Historical creation date in ISO 8601 format (e.g., 2024-01-15T10:30:00Z). Only valid when imported is true
array
Array of attachment objects to include with the reply
integer
required
ID of the conversation to reply to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_SAVED_REPLYTool 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.

Input Parameters

string
required
The name of the saved reply. This is used to identify and search for the reply.
string
The saved reply’s text content for email messages. Supports HTML formatting with tags like
for line breaks.
string
The saved reply’s text content for chat messages. Use plain text with newline characters (\n) for line breaks instead of HTML.
integer
required
The mailbox ID where the saved reply will be created. This identifies which mailbox the saved reply belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_SOCIAL_PROFILETool 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.

Input Parameters

string ("twitter" | "facebook" | "linkedin" | "instagram" | "youtube" | "pinterest" | "github" | "other")
required
The type of social profile (e.g., linkedin, twitter, facebook, instagram, youtube, pinterest, github, or other).
string
required
The social profile URL or handle. For URLs, provide the full URL (e.g., ‘https://linkedin.com/in/testuser123’). For handles, provide the username.
integer
required
The unique identifier of the customer to add the social profile to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_CREATE_WEBHOOKTool 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.

Input Parameters

string
required
The callback URL where webhook events will be sent
string
Label to identify the webhook
string ("enabled" | "disabled")
Webhook state.
array
required
Array of event names to subscribe to for webhook notifications
string
required
Secret key for webhook signature verification (max 40 characters)
array
Array of mailbox IDs to scope webhook to specific mailboxes. If omitted, webhook applies to all mailboxes
boolean
If true, sends only resource URI instead of full payload
string ("V2")
Webhook payload version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CHAT_HANDLETool to delete a chat handle for a customer. Use when you need to remove a chat handle associated with a customer account.

Input Parameters

string
required
The unique identifier for the chat handle to be deleted
string
required
The unique identifier for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CONVERSATIONTool 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.

Input Parameters

string
required
The unique identifier of the conversation to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMERTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMER_ADDRESSTool to delete a customer’s address from Help Scout. Use when you need to remove address information associated with a specific customer account.

Input Parameters

integer
required
The unique identifier for the customer whose address should be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMER_EMAILTool to delete an email for a customer. Use when you need to remove a customer’s email address from Help Scout.

Input Parameters

string
required
The email identifier to delete
string
required
The customer identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMER_PHONETool 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.

Input Parameters

integer
required
The unique identifier for the phone number to delete
integer
required
The unique identifier for the customer whose phone should be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMER_PROPERTYTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_CUSTOMER_WEBSITETool to delete a website for a customer. Use when you need to remove a website from a customer record.

Input Parameters

string
required
The unique identifier for the website to be deleted
string
required
The unique identifier for the customer

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_ORGANIZATIONTool 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.

Input Parameters

integer
required
The organization’s unique identifier to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_ORGANIZATION_PROPERTY_CUSTOMER_TIERDelete an organization custom property definition by its slug, including the customer-tier property.

Input Parameters

string
required
The property definition identifier slug. Use ‘customer-tier’ to delete the customer tier property.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_SAVED_REPLYDelete a saved reply from a Help Scout mailbox. The tool returns an empty response on success.

Input Parameters

string
required
The unique identifier for the mailbox containing the saved reply to delete.
string
required
The unique identifier for the saved reply to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_SNOOZETool 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).

Input Parameters

string
required
The unique identifier of the conversation to remove the snooze from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_SOCIAL_PROFILETool 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.

Input Parameters

integer
required
The unique identifier of the customer who owns the social profile.
integer
required
The unique identifier of the social profile to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_THREAD_SCHEDULETool 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.

Input Parameters

integer
required
The unique identifier of the thread to unschedule
integer
required
The unique identifier of the conversation containing the thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DELETE_WEBHOOKTool to permanently delete a webhook subscription from Help Scout. Use when you need to remove webhook integrations that are no longer needed.

Input Parameters

integer
required
The unique identifier of the webhook to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_DOWNLOAD_ATTACHMENTTool to download an attachment file from a Help Scout conversation. Use when you need to retrieve the actual file content of an attachment.

Input Parameters

integer
required
The unique identifier of the attachment file to download
integer
required
The unique identifier of the conversation containing the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ATTACHMENT_DATATool to retrieve attachment data for a specific attachment. Returns base64-encoded attachment content.

Input Parameters

string
required
The unique identifier of the attachment to retrieve
string
required
The unique identifier of the conversation containing the attachment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_BUSY_TIMES_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CHAT_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_COMPANY_CUSTOMERS_HELPED_REPORTTool 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.

Input Parameters

string
required
Conclusion of current time interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
string
Comma-separated list of tag IDs for filtering. Example: ‘111,222,333’
string
required
Beginning of current time interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string ("email" | "chat" | "phone")
Types of conversations supported by Help Scout.
string ("day" | "week" | "month")
Data resolution options for viewing report data.
string
Comma-separated list of folder IDs for filtering. Example: ‘10,20,30’
string
Comma-separated list of mailbox/inbox IDs for filtering. Example: ‘123,456,789’
string
Conclusion of comparison period in ISO 8601 format. If provided, previousStart must also be provided.
string
Beginning of comparison period in ISO 8601 format. If provided, previousEnd must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_COMPANY_DRILLDOWN_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
integer
Page number for pagination. Default is 1.
integer
Results per page. Default is 25, maximum is 50.
string
Comma-separated tag IDs to filter results. Example: ‘100,200’
string ("replies" | "firstReplyResolved" | "resolved" | "responseTime" | "firstResponseTime" | "handleTime")
required
Filter dimension for drill-down: replies, firstReplyResolved, resolved, responseTime, firstResponseTime, or handleTime. Required.
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string ("email" | "chat" | "phone")
Conversation type values.
string
Comma-separated folder IDs to filter results. Example: ‘10,20’
integer
Specific range bucket ID (1-10 depending on range type)
string
Comma-separated inbox IDs to filter results. Example: ‘123,456’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_COMPANY_REPORTTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Required.
string
Comma-separated list of tag IDs to filter the report. Optional.
string
required
Start of the reporting interval in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Required.
string
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
string
Comma-separated list of folder IDs to filter the report. Optional.
string
Comma-separated list of inbox IDs to filter the report. Optional.
string
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
string
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CONVERSATIONTool 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.

Input Parameters

string
Allows loading sub-entities. Valid value: ‘threads’ to include conversation threads in the response
integer
required
Unique identifier for the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CONVERSATIONS_DRILLDOWNTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format
integer
Page number for pagination (default: 1)
integer
Number of results per page (default: 25, max: 50)
string
Comma-separated list of tag IDs to filter by
string
required
Beginning of the reporting interval in ISO 8601 format
string ("email" | "chat" | "phone")
Conversation type options.
string
Comma-separated list of folder IDs to filter by
string
Comma-separated list of mailbox IDs to filter by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CONVERSATIONS_FIELD_DRILLDOWNTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CONVERSATIONS_REPORTRetrieves the overall Help Scout conversations report, including conversation volume, trends, busiest times, top customers, tags, and custom field analytics, with optional previous-period comparisons. Available on Plus and Pro plans.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CUSTOMERGet a Help Scout customer by ID, including available contact details, profile data, and conversation count.

Input Parameters

integer
required
Unique customer identifier to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_CUSTOMER_ADDRESSTool to retrieve a customer’s address from Help Scout. Use when you need to fetch the physical address associated with a specific customer account.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_DOCS_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_EMAIL_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_FIRST_RESPONSE_TIME_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string ("day" | "week" | "month")
Data resolution options for viewing report data.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
boolean
Whether to take office hours into consideration. Set to true to filter by office hours. Office hours must be enabled to use this filter.
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_HAPPINESS_RATINGS_REPORTTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
integer
Page number for pagination. Use to retrieve subsequent pages of results.
string
Comma-separated list of tag IDs to filter the report. Example: ‘5666,99787’
string
required
Start of the reporting interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string
Comma-separated list of conversation types to filter by. Valid values: email, chat, phone. Example: ‘email,chat’
string ("great" | "ok" | "all" | "not-good")
Enumeration for rating filter options.
string
Comma-separated list of folder IDs to filter the report. Example: ‘100,200’
string
Comma-separated list of mailbox IDs to filter the report. Example: ‘123,567’
string ("number" | "modifiedAt" | "rating")
Enumeration for sort field options.
string ("ASC" | "DESC")
Enumeration for sort order options.
string
Prior interval end for comparison purposes in ISO 8601 format. Example: ‘2023-12-31T23:59:59Z’
string
Prior interval start for comparison purposes in ISO 8601 format. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_HAPPINESS_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_INBOXTool 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.

Input Parameters

string
required
Unique identifier for the inbox to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_NEW_CONVERSATIONS_DRILLDOWNTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_NEW_CONVERSATIONS_REPORTTool 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.

Input Parameters

string
required
End of the time interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
string
Comma-separated tag IDs to filter results. Example: ‘10,20,30’
string
required
Start of the time interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string ("email" | "chat" | "phone")
Types of conversations supported by Help Scout.
string ("day" | "week" | "month")
Data resolution options for viewing report data.
string
Comma-separated folder IDs to filter results. Example: ‘100,200’
string
Comma-separated inbox IDs to filter results. Example: ‘123,456’
string
Ending of prior comparison period in ISO 8601 format. Example: ‘2023-12-31T23:59:59Z’
string
Beginning of prior comparison period in ISO 8601 format. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ORGANIZATIONTool 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.

Input Parameters

boolean
Whether to include customer and conversation counts in the response.
integer
required
The unique identifier for the organization to retrieve.
boolean
Whether to include organization property values in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ORGANIZATION_CONVERSATIONSTool 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.

Input Parameters

integer
Page number for pagination (starts at 1)
integer
required
The organization ID for retrieving associated conversations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ORGANIZATION_CUSTOMERSTool 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.

Input Parameters

integer
Page number for pagination (1-based indexing)
integer
required
The organization identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ORGANIZATION_PROPERTYTool 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.

Input Parameters

string
required
Property definition’s unique slug identifier. This is the key used to identify the property in the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_PHONE_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_PRODUCTIVITY_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_RECEIVED_MESSAGES_REPORTTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Required.
string
Comma-separated list of tag IDs to filter the report. Optional.
string
required
Start of the reporting interval in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Required.
string
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
string ("day" | "week" | "month")
Enumeration for data resolution view types.
string
Comma-separated list of folder IDs to filter the report. Optional.
string
Comma-separated list of inbox IDs to filter the report. Optional.
string
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
string
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_REPLIES_SENT_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_RESOLUTION_TIME_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string ("day" | "week" | "month")
Data resolution options for viewing report data.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
boolean
Whether to take office hours into consideration. Set to true to filter by office hours. Office hours must be enabled to use this filter.
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_RESOLVED_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Required.
string
Comma-separated list of tag IDs to filter the report. Optional.
string
required
Start of the interval in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Required.
string
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
string
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.
string
Comma-separated list of folder IDs to filter the report. Optional.
string
Comma-separated list of inbox IDs to filter the report. Optional.
boolean
Whether to apply office hours calculations. Defaults to false if not provided. Optional.
string
Conclusion point for prior period comparison in ISO 8601 format. Optional.
string
Beginning point for prior period comparison in ISO 8601 format. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_RESOURCE_OWNERTool to get the authenticated user’s profile information. Use when you need to retrieve details about the current user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_ROUTING_CONFIGTool to retrieve routing configuration for a mailbox inbox. Use when you need to check assignment settings, rotation status, or user eligibility for receiving conversations.

Input Parameters

string
required
Unique identifier for the mailbox to retrieve routing configuration

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_SAVED_REPLYTool 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.

Input Parameters

string
required
The mailbox identifier containing the saved reply.
string
required
The unique identifier for the saved reply to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_TAGTool 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.

Input Parameters

integer
required
The unique identifier for the tag to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USERTool 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.

Input Parameters

integer
required
Unique identifier for the user to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_CHAT_REPORTTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_CONVERSATION_HISTORYTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’. Required.
integer
Page number for pagination. Default is 1.
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
integer
required
Identifier for the user generating the report. Required.
string
required
Start of the reporting interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string ("active" | "pending" | "closed")
Status filter options for conversation history.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
string ("number" | "repliesSent" | "responseTime" | "resolveTime")
Sort field options for conversation history.
string ("ASC" | "DESC")
Sort order options.
boolean
Apply office hours calculation. Set to true to include only conversations during office hours, false for outside office hours.
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_CUSTOMERS_HELPED_REPORTTool 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.

Input Parameters

string
required
Conclusion of the time interval in ISO 8601 format. Example: ‘2026-03-09T23:59:59Z’. Required.
string
Comma-separated list of tag IDs for filtering. Example: ‘111,222,333’
integer
required
User ID for whom the report is generated. Required.
string
required
Beginning of the time interval in ISO 8601 format. Example: ‘2026-02-07T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone.
string ("day" | "week" | "month")
Data resolution options for viewing report data.
string
Comma-separated list of folder IDs for filtering. Example: ‘10,20,30’
string
Comma-separated list of mailbox/inbox IDs for filtering. Example: ‘123,456,789’
string
Conclusion of comparison period in ISO 8601 format. If provided, previousStart must also be provided.
string
Beginning of comparison period in ISO 8601 format. If provided, previousEnd must also be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_DRILLDOWNTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_HAPPINESS_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’. Required.
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
integer
required
User ID for whom the report is generated. Required.
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_RATINGS_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’. Required.
integer
Page number for pagination. Default is 1.
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
integer
required
User ID for whom the report is generated. Required.
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string ("great" | "ok" | "all" | "not-good")
Rating filter options.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
string ("number" | "repliesSent" | "resolveTime" | "responseTime")
Sort field options for user ratings report.
string ("ASC" | "DESC")
Sort order options.
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_REPLIES_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’. Required.
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’. Optional.
integer
required
User ID for whom the report is generated. Required.
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’. Optional.
string ("day" | "week" | "month")
Data resolution options for user replies report.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’. Optional.
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’. Optional.
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’. Optional.
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_REPORTTool 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.

Input Parameters

string
required
End of the reporting interval in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Required.
string
Comma-separated list of tag IDs to filter the report. Optional.
integer
required
User ID for whom the report is generated. Required.
string
required
Start of the reporting interval in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Required.
string
Comma-separated list of conversation types to filter the report. Valid values: email, chat, phone. Optional.
string
Comma-separated list of folder IDs to filter the report. Optional.
string
Comma-separated list of inbox IDs to filter the report. Optional.
boolean
Whether to consider office hours in the report. Defaults to false if not provided. Optional.
string
End of the previous interval in ISO 8601 format for comparison metrics. Optional.
string
Start of the previous interval in ISO 8601 format for comparison metrics. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_RESOLUTIONS_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format. Example: ‘2024-01-31T23:59:59Z’. Required.
string
Comma-separated list of tag IDs to filter results. Example: ‘10,20,30’
integer
required
User ID for whom the report is generated. Required.
string
required
Start of the interval in ISO 8601 format. Example: ‘2024-01-01T00:00:00Z’. Required.
string
Comma-separated list of conversation types to filter results. Valid values: email, chat, phone. Example: ‘email,chat’
string ("day" | "week" | "month")
Granularity options for viewing resolution data.
string
Comma-separated list of folder IDs to filter results. Example: ‘100,200’
string
Comma-separated list of inbox IDs to filter results. Example: ‘123,456,789’
string
End of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-31T23:59:59Z’
string
Start of the previous interval in ISO 8601 format for comparison. Example: ‘2023-12-01T00:00:00Z’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_USER_STATUSTool 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.

Input Parameters

integer
required
The unique identifier of the user whose status to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_VOLUME_BY_CHANNEL_REPORTTool 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.

Input Parameters

string
required
End of the interval in ISO 8601 format (e.g., ‘2024-01-31T23:59:59Z’). Required parameter for the report date range.
string
Comma-separated list of tag IDs to filter results. Only includes conversations with specified tags.
string
required
Start of the interval in ISO 8601 format (e.g., ‘2024-01-01T00:00:00Z’). Required parameter for the report date range.
string
Comma-separated list of conversation types to include. Valid values: email, chat, phone. If not specified, all types are included.
string ("day" | "week" | "month")
Data resolution period options.
string
Comma-separated list of folder IDs to filter results. Only includes conversations from specified folders.
string
Comma-separated list of mailbox IDs to filter results. Only includes conversations from specified mailboxes.
string
Ending date for comparison period in ISO 8601 format. When provided with previousStart, enables comparison with a previous time period.
string
Beginning date for comparison period in ISO 8601 format. When provided with previousEnd, enables comparison with a previous time period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_GET_WEBHOOKTool 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.

Input Parameters

integer
required
The unique identifier of the webhook to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CHAT_HANDLESTool 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.

Input Parameters

integer
required
Unique identifier for the customer whose chat handles to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CONVERSATIONSLists and filters Help Scout conversations by status, tags, assignee, modification date, and other criteria. Returns paginated conversation details including subject, status, customer information, and tags.

Input Parameters

string
Filter by tag name. Returns conversations tagged with the specified tag.
integer
Page number for pagination. Use to retrieve subsequent pages of results.
string
Search query using Mailbox API query syntax. Allows complex filtering with operators like AND, OR, NOT.
integer
Filter by conversation number. Returns the conversation with this specific number.
string ("active" | "all" | "closed" | "open" | "pending" | "spam")
Conversation status values.
integer
Filter by mailbox ID. Returns conversations from the specified mailbox only.
string ("createdAt" | "customerEmail" | "customerName" | "mailboxid" | "modifiedAt" | "number" | "score" | "status" | "subject")
Sort field options for conversations.
string ("asc" | "desc")
Sort order options.
integer
Filter by assigned user ID. Returns conversations assigned to the specified user.
string
Filter by modification date. Returns conversations modified since this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CUSTOMER_EMAILSTool 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.

Input Parameters

integer
required
Unique identifier for the customer whose emails to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CUSTOMER_PHONESTool to list all phone numbers for a specific Help Scout customer. Use when you need to retrieve the phone contact information for a customer.

Input Parameters

integer
required
The unique identifier of the customer whose phones to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CUSTOMER_PROPERTIESTool to list all customer property definitions. Use when you need to view all custom properties configured for customers in the Help Scout account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CUSTOMERSTool 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.

Input Parameters

integer
Page number for pagination (starts at 1)
string
Filter customers by email address
string
Filter customers by last name
string
Filter customers by first name
string
Filter customers modified since this date in ISO 8601 format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_CUSTOMER_WEBSITESTool 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.

Input Parameters

integer
required
Unique customer identifier to retrieve websites for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_INBOX_CUSTOM_FIELDSTool 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.

Input Parameters

string
required
Unique identifier for the mailbox to retrieve custom fields from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_INBOXESTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_INBOX_FOLDERSList folders in a specific Help Scout inbox, including details such as conversation counts. Results are retrieved one page at a time.

Input Parameters

integer
Page number to retrieve. Default: 1.
string
required
Unique identifier for the mailbox to retrieve folders from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_ORGANIZATIONSTool 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.

Input Parameters

string
Filter organizations by name. Performs a partial match search.
integer
Page number for pagination (starts at 1). Default is 1.
string ("name" | "createdAt" | "modifiedAt")
Sort field options for organizations.
string ("asc" | "desc")
Sort order options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_ORGANIZATIONS_PROPERTIESTool to list all organization property definitions. Use when you need to view all custom properties configured for organizations in the Help Scout account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_SAVED_REPLIESTool to list saved replies for a mailbox. Use when you need to retrieve all saved reply templates available in a specific mailbox.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_SOCIAL_PROFILESTool 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.).

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_TAGSTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_TEAMSTool to list all teams in Help Scout with pagination support. Use when you need to retrieve a list of all available teams.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_THREADSList threads for a specific Help Scout conversation, with page selection for retrieving its message history and interactions. Threads are sorted by creation time from newest to oldest by default.

Input Parameters

integer
Page number to retrieve. Default: 1.
integer
required
The unique conversation identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_USERSList a page of Help Scout account users, optionally filtered by mailbox or email. Results include user details and pagination metadata.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_USERS_STATUSList a page of Help Scout user statuses, including email and chat availability. Use the page parameter to retrieve other pages.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_WEBHOOKSList Help Scout webhook subscriptions and their configurations. The response may include pagination metadata and links; the tool makes one request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_LIST_WORKFLOWSTool 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.

Input Parameters

integer
Page number for pagination (starts at 1)
string ("automatic" | "manual")
Workflow type enumeration.
string ("active" | "inactive" | "invalid")
Workflow status enumeration.
integer
Filter workflows by mailbox ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_OVERWRITE_CUSTOMERTool 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.

Input Parameters

string
Age or age range descriptor. If not provided, will be set to null.
string
Phone number for the customer. Used when creating new customer.
string ("male" | "female" | "unknown")
Gender enumeration for customer profiles.
string
Job title (max 60 characters). If not provided, will be set to null.
string
Customer’s last name (1-40 characters). If not provided, will be set to null.
string
Customer’s location (max 60 characters). If not provided, will be set to null.
string
URL to profile photo (max 200 characters). If not provided, will be set to null.
string
Customer’s first name (1-40 characters). If not provided, will be set to null.
string ("unknown" | "gravatar" | "twitter" | "facebook" | "googleprofile" | "googleplus" | "linkedin" | "instagram")
Photo type enumeration for customer profile photos.
string
Background information or notes from the user interface (max 200 characters). If not provided, will be set to null.
integer
required
Unique customer identifier to overwrite
string
Organization name (max 60 characters). DEPRECATED: use organizationId instead. If not provided, will be set to null.
integer
Organization ID reference. If not provided, will be set to null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_PUBLISH_THREAD_SCHEDULETool 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.

Input Parameters

integer
required
The unique identifier of the scheduled thread to publish immediately
integer
required
The unique identifier of the conversation containing the scheduled thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_REMOVE_ORGANIZATION_PROPERTY_VALUETool 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.

Input Parameters

string
required
Property definition’s unique slug identifier. This is the key used to identify the property in the API.
integer
required
The organization’s unique identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_RUN_MANUAL_WORKFLOWTool 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.

Input Parameters

integer
required
The identifier of the manual workflow to execute
array
required
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_SET_ORGANIZATION_PROPERTY_VALUETool 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.

Input Parameters

string
required
Property definition’s unique slug identifier. This is the key used to identify the property in the API.
string
required
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.
integer
required
Unique identifier of the organization to set the property value for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_SET_USER_STATUSTool 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.

Input Parameters

string ("active" | "away")
required
The status to set for the user: ‘active’ (available) or ‘away’ (unavailable)
integer
required
The unique identifier of the user whose status to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CHAT_HANDLETool 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.

Input Parameters

string ("aim" | "gtalk" | "icq" | "msn" | "other" | "qq" | "skype" | "xmpp" | "yahoo")
required
Chat platform type. Must be one of: aim, gtalk, icq, msn, other, qq, skype, xmpp, yahoo
string
required
The updated chat handle/username on the specified platform
integer
required
The customer ID whose chat handle to update
integer
required
The chat handle ID to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CONVERSATIONUpdate one property of a Help Scout conversation using a JSON Patch operation. Use it to modify the subject, status, assignment, mailbox, primary customer, or draft status.

Input Parameters

string ("add" | "move" | "remove" | "replace")
required
JSON Patch operation: add, move, remove, or replace
string
required
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)
string
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
integer
required
The unique identifier of the conversation to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CONVERSATION_TAGSTool 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.

Input Parameters

array
required
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
integer
required
Unique identifier for the conversation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CONVERSATION_THREAD_SCHEDULETool 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.

Input Parameters

integer
required
Identifier for the thread to schedule
string
required
ISO 8601 date string in the future when the thread should be sent. Must not be after year 2100.
boolean
Whether the reply should be sent as the draft’s original creator. Defaults to false.
integer
required
Identifier for the conversation containing the thread
boolean
required
Determines if a new customer reply should unschedule the thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMERTool 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.).

Input Parameters

array
required
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).
integer
required
Unique customer identifier to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_ADDRESSTool to update an existing address for a Help Scout customer. Use when you need to modify a customer’s physical address.

Input Parameters

string
required
City of the address.
array
Address lines (street address, building number, etc.).
string
required
State or province of the address.
string
required
Country code of the address (typically 2-letter ISO code).
integer
required
The unique identifier for the customer.
string
required
Postal code or ZIP code of the address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_EMAILTool 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).

Input Parameters

string ("home" | "other" | "work")
required
Email category - home, other, or work
string
required
Updated email address for the customer
string
required
Identifier of the email entry to update
string
required
Identifier of the customer whose email to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_PHONETool to update an existing phone number for a Help Scout customer. Use when modifying phone number details or type for a customer’s profile.

Input Parameters

string ("fax" | "home" | "mobile" | "other" | "pager" | "work")
required
Phone location type. Must be one of: fax, home, mobile, other, pager, work
string
required
The updated telephone number
integer
required
The unique identifier for the phone number to update
integer
required
The unique identifier for the customer whose phone should be updated

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_PROPERTIESTool 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.

Input Parameters

integer
required
The unique identifier of the customer whose properties to update
array
required
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_SOCIAL_PROFILETool 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.

Input Parameters

string ("aboutme" | "facebook" | "flickr" | "forsquare" | "google" | "googleplus" | "linkedin" | "other" | "quora" | "tungleme" | "twitter" | "youtube")
required
The type of social profile (e.g., twitter, facebook, linkedin, etc.).
string
required
The social profile URL or handle. For URLs, provide the full URL (e.g., ‘https://twitter.com/testuser’). For handles, provide the username.
integer
required
The unique identifier of the customer who owns the social profile.
integer
required
The unique identifier of the social profile to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOMER_WEBSITETool to update an existing website URL for a customer in Help Scout. Use when modifying a website entry on a customer’s profile.

Input Parameters

string
required
The updated website URL
integer
required
The ID of the website entry to update
integer
required
The ID of the customer whose website to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_CUSTOM_FIELDSTool 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.

Input Parameters

array
required
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.
integer
required
The unique conversation identifier

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_MAILBOXES_ROUTINGTool 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.

Input Parameters

string ("enabled" | "disabled")
required
Routing configuration state - ‘enabled’ or ‘disabled’
array
required
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.
string
required
Unique identifier for the mailbox to update routing configuration
integer
required
Maximum number of conversations that can be assigned (range: 1-100)
string ("round_robin" | "balanced")
required
Assignment strategy for distributing conversations - ‘round_robin’ assigns to users in sequence, ‘balanced’ assigns to users with fewest active conversations

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_ORGANIZATIONTool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_ORGANIZATION_PROPERTYTool 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.

Input Parameters

string
required
Updated name of the property; maximum 100 characters
string
required
The identifier for the organization property being updated. This is the property’s unique slug.
array
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_ORGANIZATION_PROPERTY_INDUSTRYTool 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.

Input Parameters

string
required
Updated display name for the industry property. Maximum 100 characters.
array
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_SAVED_REPLYTool 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.

Input Parameters

string
required
The name of the saved reply. This is used to identify and search for the reply.
string
The saved reply’s text content for email messages. Supports HTML formatting with tags like
for line breaks.
string
The saved reply’s text content for chat messages. Use plain text with newline characters (\n) for line breaks instead of HTML.
string
required
The mailbox ID where the saved reply exists. This identifies which mailbox the saved reply belongs to.
string
required
The unique identifier of the saved reply to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_SNOOZETool 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.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_THREADTool 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.

Input Parameters

string ("replace")
required
JSON Patch operation type. Only ‘replace’ is supported for thread updates
string ("/text" | "/hidden")
required
Field path to update. Valid paths: /text (modify thread text content), /hidden (hide/unhide thread - applies to non-draft customer or reply threads only)
string
required
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
integer
required
The unique identifier of the thread to update
integer
required
The unique identifier of the conversation containing the thread

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_WEBHOOKUpdate an existing Help Scout webhook subscription by ID. The update requires the callback URL, subscribed events, and secret, and can include other configuration settings.

Input Parameters

string
required
The callback URL where webhook events will be sent
string
Label to identify the webhook
array
required
Array of event names to subscribe to for webhook notifications
string
required
Secret key for webhook signature verification (max 40 characters)
array
Array of mailbox IDs to scope webhook to specific mailboxes. If omitted, webhook applies to all mailboxes
integer
required
The unique identifier of the webhook to update
boolean
If true, sends only resource URI instead of full payload
string ("V2")
Webhook payload version.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: HELP_SCOUT_UPDATE_WORKFLOW_STATUSTool to update the status of a Help Scout workflow (enable/disable automation rule). Use when you need to activate or deactivate a workflow.

Input Parameters

string ("active" | "inactive")
required
New status for the workflow: active to enable, inactive to disable
integer
required
The unique identifier of the workflow to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not