Help Scout Delete Conversation
Permanently delete a Help Scout conversation by id. Merged conversations return not-found on the old id — resolve the current id with a single-row fetch first.
Help Scout Delete Customer
Permanently delete a Help Scout customer and their conversations (GDPR erasure). Fails with forbidden when the customer has more than 100 conversations or the caller lacks access to all of their tickets.
Help Scout Get Conversations
List or fetch Help Scout support conversations (email, chat, phone). Omit id to list with optional status, mailbox, query, sort, and page filters. Pass id to fetch one conversation; set embed to threads to inline the message timeline on that row. Pass id with sub_resource threads to read only the thread list for a ticket — use a current id from a recent list response; stale or merged ids may return not-found on thread reads.
Help Scout Get Customers
List or fetch Help Scout customer profiles with contact details and custom properties. Omit id to list with optional query search, sort, and page. Pass id to retrieve one customer including embedded emails, phones, and tags.
Help Scout Get Inboxes
List Help Scout inboxes (mailboxes) or read inbox-scoped metadata. Omit id to list every inbox. Pass inbox id with sub_resource fields to list custom fields for that inbox, or sub_resource folders to list mailbox folders.
Help Scout Get Tags
List every conversation tag defined in the connected Help Scout account. Tags are account-wide labels used for filtering and reporting.
Help Scout Get Teams
List Help Scout teams (omit id) or list members for one team (pass id). Optional page paginates HAL responses. Parameter id is the Help Scout team id — when set, the response is that team's member roster, not a single team record.
Help Scout Get Users
List Help Scout account users or fetch one profile. Omit id to list every user. Pass me as id to load the authenticated agent profile, or pass a numeric user id.
Help Scout Get Workflows
List automated workflows configured in Help Scout. Workflows drive routing, tagging, and status changes — use ids from this list before invoking manual runs.
Help Scout Reply To Conversation
Add an agent reply, note, or draft thread to an existing conversation. Requires conversation id, customer object, and text. Set draft true to save without sending. Optional assign_to updates the owner when the reply publishes.
Help Scout Upsert Conversation
Create or update a Help Scout conversation. Omit id to POST a new ticket — requires subject, mailbox_id, type (email, chat, or phone), customer object, and at least one thread in threads. Pass id to PATCH with patch_operations (JSON Patch array: op, path, value) for subject, status, assignTo, mailboxId, or primaryCustomer changes.
Help Scout Upsert Customer
Create or update a Help Scout customer profile. Omit id to POST a new customer (first_name, last_name, emails, phones, and other profile fields). Pass id to PATCH with patch_operations (JSON Patch array) for profile or contact-entry changes.
