Help Scout

List conversations from Help Scout with filtering and pagination. Returns a paginated list of conversations. By default only active conversations are returned. Args: - mailbox: Filter by mailbox ID - folder: Filter by folder ID - status: Filter by status (active, pending, closed, spam, open, all) - tag: Filter by tag name(s), comma-separated - assignedTo: Filter by assigned user ID - modifiedSince: ISO 8601 date to filter by modification date - sortField: Sort by field (createdAt, customerEmail, status, subject) - sortOrder: Sort direction (asc, desc) - query: Advanced search query - page: Page number (1-indexed) - format: Response format (json or markdown)

Get a single conversation by ID with its threads. Args: - conversationId: The conversation ID - format: Response format (json or markdown) Returns the conversation with all threads embedded.

Create a new conversation in Help Scout. Args: - mailboxId: ID of the mailbox to create in (required) - subject: Conversation subject (required) - type: Conversation type - email, chat, or phone (required) - status: Initial status - active, pending, or closed (required) - customerEmail: Customer's email address (required) - customerFirstName: Customer's first name - customerLastName: Customer's last name - customerId: Existing customer ID (alternative to email) - text: Initial message text (required) - threadType: Type of initial thread - customer or reply - assignTo: User ID to assign the conversation to - tags: Comma-separated list of tags Returns the created conversation ID and location.

Update a conversation's properties. Supported operations: - Change subject: path=/subject, value=new subject - Change status: path=/status, value=active|pending|closed - Assign to user: path=/assignTo, value=user ID - Unassign: path=/assignTo (with op=remove) - Change mailbox: path=/mailboxId (with op=move), value=new mailbox ID - Change customer: path=/primaryCustomer.id, value=customer ID Args: - conversationId: The conversation ID - op: Operation type (replace, remove, or move) - path: Field path to update - value: New value (not needed for remove)

Delete a conversation. Args: - conversationId: The conversation ID to delete

List all threads in a conversation. Args: - conversationId: The conversation ID - page: Page number (1-indexed) - format: Response format (json or markdown)

Send a reply to a conversation. Args: - conversationId: The conversation ID - customerId: The customer ID (required) - text: Reply text content (required) - draft: Create as draft instead of sending - status: Set conversation status after reply (active, pending, closed) - assignTo: Assign to user ID after reply

Add an internal note to a conversation (not visible to customer). Args: - conversationId: The conversation ID - text: Note text content (required) - status: Optionally change conversation status

Add a customer message to a conversation (simulates customer reply). Args: - conversationId: The conversation ID - text: Message text (required) - customerEmail: Customer email (or use customerId) - customerId: Customer ID (or use customerEmail) - imported: Mark as imported (won't trigger notifications)

List customers from Help Scout with filtering and pagination. Args: - mailbox: Filter by mailbox ID - firstName: Filter by first name - lastName: Filter by last name - email: Filter by exact email match - modifiedSince: ISO 8601 date to filter by modification date - sortField: Sort by field (createdAt, firstName, lastName, modifiedAt) - sortOrder: Sort direction (asc, desc) - query: Advanced search query - page: Page number (1-indexed) - format: Response format (json or markdown)

Get a single customer by ID with all details. Args: - customerId: The customer ID - format: Response format (json or markdown) Returns the customer with emails, phones, addresses, social profiles, etc.

Create a new customer in Help Scout. Args: - email: Primary email address (required) - emailType: Email type (home, work, other) - firstName: First name - lastName: Last name - phone: Phone number - phoneType: Phone type (home, work, mobile, fax, pager, other) - jobTitle: Job title - organization: Organization/company name - organizationId: Link to existing organization - location: Location string - background: Background notes - gender: Gender (male, female, unknown) Returns the created customer ID.

Update a customer's properties using JSON Patch operations. Common operations: - Update first name: op=replace, path=/firstName, value=NewName - Update last name: op=replace, path=/lastName, value=NewName - Update job title: op=replace, path=/jobTitle, value=NewTitle - Add email: op=add, path=/emails, value={"type":"work","value":"new@example.com"} - Remove specific email: op=remove, path=/emails/123 (use email ID) Args: - customerId: The customer ID - op: Operation type (add, replace, remove) - path: Field path to update - value: New value (JSON string for complex values)

Delete a customer from Help Scout. Args: - customerId: The customer ID to delete

List all mailboxes (inboxes) in Help Scout. Args: - page: Page number (1-indexed) - format: Response format (json or markdown) Returns mailbox details including ID, name, email, and slug.

Get a single mailbox by ID. Args: - mailboxId: The mailbox ID - format: Response format (json or markdown)

List all folders in a mailbox. Args: - mailboxId: The mailbox ID - page: Page number (1-indexed) - format: Response format (json or markdown) Returns folder details including conversation counts.

List all custom fields configured for a mailbox. Args: - mailboxId: The mailbox ID - page: Page number (1-indexed) - format: Response format (json or markdown) Returns custom field definitions including name, type, and options.

List all saved replies (canned responses) for a mailbox. Args: - mailboxId: The mailbox ID - page: Page number (1-indexed) - format: Response format (json or markdown)

Get a single saved reply by ID. Args: - mailboxId: The mailbox ID - savedReplyId: The saved reply ID - format: Response format (json or markdown)

Create a new saved reply (canned response) in a mailbox. Args: - mailboxId: The mailbox ID - name: Name/title for the saved reply - text: The reply text content

Update an existing saved reply. Args: - mailboxId: The mailbox ID - savedReplyId: The saved reply ID - name: New name/title - text: New reply text content

Delete a saved reply from a mailbox. Args: - mailboxId: The mailbox ID - savedReplyId: The saved reply ID to delete

List all organizations (companies) in Help Scout. Args: - sort: Sort field and direction (e.g., "name,asc", "lastInteractionAt,desc") Available fields: name, customerCount, conversationCount, lastInteractionAt - page: Page number (1-indexed) - format: Response format (json or markdown)

Get a single organization by ID. Args: - organizationId: The organization ID - format: Response format (json or markdown)

Create a new organization in Help Scout. Args: - name: Organization name (required) - website: Website URL - description: Description text - location: Location string - logoUrl: Logo image URL - note: Internal notes - domains: Comma-separated list of domains - brandColor: Brand color hex code

Update an existing organization. Args: - organizationId: The organization ID - name: New organization name - website: New website URL - description: New description - location: New location - logoUrl: New logo URL - note: New internal notes - domains: New comma-separated domains - brandColor: New brand color hex

Delete an organization from Help Scout. Args: - organizationId: The organization ID to delete

List customer satisfaction ratings within a date range. Args: - start: Start date in ISO 8601 format (required) - end: End date in ISO 8601 format (required) - mailbox: Filter by mailbox ID - rating: Filter by rating value (great, okay, bad) - sortField: Sort by field (rating, modifiedAt) - sortOrder: Sort direction (asc, desc) - page: Page number (1-indexed) - format: Response format (json or markdown)

List all tags in Help Scout. Tags are shared across all mailboxes and returned in alphabetical order. Args: - page: Page number (1-indexed) - format: Response format (json or markdown) Returns tag details including name, color, and conversation count.

List all teams in Help Scout. Args: - page: Page number (1-indexed) - format: Response format (json or markdown)

List all members of a specific team. Args: - teamId: The team ID - page: Page number (1-indexed) - format: Response format (json or markdown)

List all users in Help Scout. Args: - email: Filter by exact email match - mailbox: Filter by mailbox ID - page: Page number (1-indexed) - format: Response format (json or markdown) Returns users including pending invitations.

Get a single user by ID. Args: - userId: The user ID - format: Response format (json or markdown)

Get the currently authenticated user. Args: - format: Response format (json or markdown)

List all webhooks in Help Scout. Args: - page: Page number (1-indexed) - format: Response format (json or markdown)

Get a single webhook by ID. Args: - webhookId: The webhook ID - format: Response format (json or markdown)

Create a new webhook in Help Scout. Common events: - convo.assigned, convo.created, convo.deleted, convo.merged, convo.moved - convo.status, convo.tags, convo.customer.reply.created - customer.created, customer.updated - satisfaction.ratings Args: - url: Endpoint URL to receive webhook notifications (required) - events: Comma-separated list of event types to subscribe to (required) - secret: Secret key for signature verification, max 40 chars (required) - label: Descriptive label for the webhook - notification: If true, only sends URL (no payload) - mailboxIds: Comma-separated mailbox IDs to scope webhook (omit for all)

Update an existing webhook. Args: - webhookId: The webhook ID - url: New endpoint URL - events: New comma-separated event types - secret: New secret key - label: New label - state: Enable or disable (enabled, disabled) - notification: Notification-only mode - mailboxIds: Comma-separated mailbox IDs

Delete a webhook. Args: - webhookId: The webhook ID to delete

List all workflows in Help Scout. Args: - mailboxId: Filter by mailbox ID - type: Filter by workflow type (manual, automatic) - page: Page number (1-indexed) - format: Response format (json or markdown)

Run a manual workflow on one or more conversations. Only manual workflows can be triggered via API. Args: - workflowId: The workflow ID to run - conversationIds: Comma-separated list of conversation IDs

Activate or deactivate a workflow. Args: - workflowId: The workflow ID - status: New status (active, inactive)