# Supportbee

SupportBee is a web-based email support tool that helps businesses organize their customer support emails efficiently.

- **Category:** customer support
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 43
- **Triggers:** 0
- **Slug:** `SUPPORTBEE`
- **Version:** 20260227_00

## Tools

### Add Label to Ticket

**Slug:** `SUPPORTBEE_ADD_LABEL_TO_TICKET`

Tool to add a label to a ticket. Use when you need to categorize or tag a ticket with a specific label. The label must already exist in your SupportBee account before adding it to a ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | The unique ID of the ticket to add the label to |
| `label_name` | string | Yes | The name of the label to add to the ticket. The label must already exist in your SupportBee account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive SupportBee Ticket

**Slug:** `SUPPORTBEE_ARCHIVE_TICKET`

Tool to archive a SupportBee ticket by its ID. Use when you want to move resolved tickets to the archive.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Unique identifier of the ticket to archive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Assign Ticket to Team

**Slug:** `SUPPORTBEE_ASSIGN_TICKET_TO_TEAM`

Assigns a ticket to a team in SupportBee. Use when you need to route a support ticket to a specific team for handling. Note: If the ticket is already assigned to a team and a user, reassigning to another team will remove the user assignee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | integer | Yes | The unique ID of the team to assign the ticket to |
| `ticket_id` | integer | Yes | The unique ID of the ticket to assign to a team |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ticket Comment

**Slug:** `SUPPORTBEE_CREATE_COMMENT`

Creates an internal comment on a ticket in SupportBee. Comments are private notes visible only to agents, not to customers. Use this to add internal notes, observations, or collaborate with team members on a ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | object | Yes | Content of the comment. Provide either text or html (or both). |
| `ticket_id` | string | Yes | The unique identifier of the ticket to add a comment to. Obtain this from list_tickets or search_tickets actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Consequence

**Slug:** `SUPPORTBEE_CREATE_CONSEQUENCE`

Creates a new consequence for rules automation in SupportBee. Use when setting up automated actions that should be triggered by rules (e.g., auto-assign tickets, archive, or mark as spam).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `spam` | boolean | No | Set to true to automatically mark the ticket as spam when this consequence is triggered |
| `label` | string | No | A descriptive label for the consequence to identify its purpose |
| `archive` | boolean | No | Set to true to automatically archive the ticket when this consequence is triggered |
| `assign_team` | string | No | Team ID to assign the ticket to. Mutually exclusive with assign_user - cannot be used together. |
| `assign_user` | string | No | User ID to assign the ticket to. Mutually exclusive with assign_team - cannot be used together. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Forwarding Email

**Slug:** `SUPPORTBEE_CREATE_EMAIL`

Create a new forwarding email address for the company in SupportBee. Use this to add new support email addresses that will forward incoming emails to your SupportBee account as tickets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Display name for the email address. This name will be used when sending replies from this address. |
| `email` | string | Yes | The email address to create as a forwarding address. This is the address that will forward emails to SupportBee. |
| `filter_spam` | boolean | No | Whether to filter spam emails. When enabled, suspected spam emails will be automatically filtered. |
| `use_agent_name` | boolean | No | Whether to use the agent's name instead of the company name when sending replies from this address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Filter

**Slug:** `SUPPORTBEE_CREATE_FILTER`

Creates a filter in SupportBee by linking a rule with a consequence. Use this after creating both a rule (defining match conditions) and a consequence (defining actions to perform).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | ID of the rule to match. This rule defines the conditions under which the filter will be triggered. Use the Create Rule action to generate a rule and obtain its ID. |
| `consequence_id` | string | Yes | ID of the consequence to apply when the rule matches. The consequence defines the actions that will be executed when the filter conditions are met. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Rule

**Slug:** `SUPPORTBEE_CREATE_RULE`

Creates a new automation rule in SupportBee to automatically process tickets based on conditions. Rules allow you to automate ticket workflows by: - Matching tickets based on field conditions (subject, sender, body, etc.) - Automatically applying actions like labeling, archiving, assigning, or setting priority Use this after fetching available labels/teams to get valid IDs for actions. The rule will be evaluated for all new and existing tickets matching the conditions. Returns the created rule's unique ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the rule to be created |
| `active` | boolean | No | Flag indicating if the rule should be active upon creation |
| `actions` | array | Yes | List of one or more actions to execute when conditions match |
| `conditions` | array | Yes | List of one or more conditions that trigger the rule |
| `sort_order` | integer | No | Optional sort order for the rule, non-negative |
| `description` | string | No | Optional description for the rule |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Snippet

**Slug:** `SUPPORTBEE_CREATE_SNIPPET`

Create a reusable snippet (canned response) in SupportBee. Snippets are pre-written text templates that agents can quickly insert into ticket replies. Use this to create standard responses for common customer inquiries like refunds, FAQs, or welcome messages.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `html` | string | No | The HTML formatted content of the snippet. If not provided, the plain text will be used. Supports basic HTML formatting like <b>, <i>, <a>, <br>, etc. |
| `name` | string | Yes | The name/title for the snippet. This will be displayed when selecting snippets. |
| `tags` | string | No | Comma-separated tags to categorize the snippet (e.g., 'refund, policy, billing'). |
| `text` | string | Yes | The plain text content of the snippet. Used in text-only email responses. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SupportBee Ticket

**Slug:** `SUPPORTBEE_CREATE_TICKET`

Creates a new support ticket in SupportBee with a subject, content, and requester details. Use this action to: - Create tickets from customer inquiries or issues - Assign tickets to specific agents or teams during creation - Add tags and labels for better ticket organization - Include CC recipients to keep stakeholders informed The ticket will be created in an unanswered state and will appear in the inbox unless marked as spam.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | Email addresses to CC on the ticket. These recipients will receive updates. |
| `spam` | boolean | No | Set to true to mark the ticket as spam. Note: The API may not honor this during creation. |
| `tags` | array | No | Tags to categorize the ticket (e.g., 'urgent', 'billing', 'bug'). |
| `labels` | array | No | Custom labels for the ticket. Use label names from your SupportBee account. |
| `content` | string | Yes | Main content/body of the ticket. Describe the issue or request in detail. |
| `subject` | string | Yes | Subject line of the ticket. Should be concise and descriptive. |
| `team_id` | integer | No | Team ID to assign this ticket to. Use Fetch Teams to get valid team IDs. |
| `agent_id` | integer | No | Agent ID to assign this ticket to. Use Fetch Teams/Users to get valid agent IDs. |
| `requester` | object | Yes | Requester information. Email is required; name is optional but recommended. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ticket Reply

**Slug:** `SUPPORTBEE_CREATE_TICKET_REPLY`

Create a reply to a support ticket in SupportBee. Replies are sent to customers via email and are visible to them. Use this when you need to respond to a customer's ticket with information, updates, or solutions. Provide the ticket ID and HTML-formatted content for your reply.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `content` | string | Yes | Content of the reply in HTML format |
| `user_id` | integer | No | ID of the user replying; if omitted, the current user is used |
| `ticket_id` | string | Yes | ID of the ticket to reply to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SupportBee User

**Slug:** `SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUP`

Invites a new user to your SupportBee account. The user will receive an email invitation and can be assigned as an agent (handles tickets), admin (full access), or collaborator (view/comment only). Use this when you need to add team members to your helpdesk programmatically.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Full name of the user to display in SupportBee. |
| `role` | string ("agent" | "admin" | "collaborator") | No | Role to assign to the user. 'admin' has full account access, 'agent' can handle tickets, 'collaborator' can view and comment only. Defaults to 'agent'. |
| `email` | string | Yes | Email address of the user to invite. An invitation email will be sent to this address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Snippet

**Slug:** `SUPPORTBEE_DELETE_SNIPPET`

Permanently delete a snippet by its ID from SupportBee. Use this action when you need to remove an unwanted or outdated snippet (canned response template). This action is destructive and cannot be undone. To find snippet IDs, use the 'Fetch Snippets' action first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique numeric ID of the snippet to delete. You can obtain snippet IDs by calling the 'Fetch Snippets' action first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete SupportBee Ticket

**Slug:** `SUPPORTBEE_DELETE_TICKET`

Permanently delete a trashed ticket from SupportBee. The ticket must first be moved to trash using the Trash Ticket action before it can be permanently deleted. Only admins can delete trashed tickets. This action is irreversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique numeric ID of the trashed ticket to permanently delete. The ticket must be in the trash before it can be deleted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Forwarding Emails

**Slug:** `SUPPORTBEE_FETCH_EMAILS`

Retrieve all forwarding email addresses configured for the company. Use this tool to list the support email addresses that forward emails to SupportBee.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch SupportBee Labels

**Slug:** `SUPPORTBEE_FETCH_LABELS`

Tool to retrieve all custom labels. Use when you need to list labels for ticket categorization.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch Snippets

**Slug:** `SUPPORTBEE_FETCH_SNIPPETS`

Fetches saved response snippets (canned responses/templates) from SupportBee. Snippets are reusable text templates that can be inserted into ticket replies. Use this to list available snippets for quick responses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page of results to fetch (default is 1). |
| `per_page` | integer | No | Number of snippets per page (default is 15, max is 100). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Fetch SupportBee Teams

**Slug:** `SUPPORTBEE_FETCH_TEAMS`

Retrieves all teams in the SupportBee account. Use this to list available teams before assigning tickets to teams or filtering tickets by team. Returns team IDs, names, descriptions, and timestamps.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Avg First Response Time Report

**Slug:** `SUPPORTBEE_GET_AVG_FIRST_RESPONSE_TIME_REPORT`

Tool to retrieve average first response time data points over time. Use when analyzing first-response performance metrics for support tickets. Returns time-series data with response times in seconds and Unix timestamps. Reports require admin API token access. Data is limited to a maximum 30-day window per request.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team` | integer | No | Filter data points by team ID. Only reports for the specified team will be returned. |
| `user` | integer | No | Filter data points by agent ID. Only reports for the specified agent will be returned. |
| `label` | string | No | Filter data points by label name. Only tickets with this label will be included in the report. |
| `since` | string | No | Start of reporting period. Accepts various date formats: ISO 8601 (e.g., '2023-01-01T00:00:00Z'), YYYY-MM-DD (e.g., '2023-01-01'), or verbose formats (e.g., '15th Feb 2023'). Data points returned for max 30 days window. |
| `until` | string | No | End of reporting period. Accepts various date formats: ISO 8601 (e.g., '2023-01-31T23:59:59Z'), YYYY-MM-DD (e.g., '2023-01-31'), or verbose formats. Data points returned for max 30 days window. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Replies Count Report

**Slug:** `SUPPORTBEE_GET_REPLIES_COUNT_REPORT`

Retrieves replies count report data for the company. Returns time-series data points showing the number of replies over time. The report provides aggregate metrics for the entire company account and includes type information (company/user/team), the entity ID, and the metric name. Requires admin-level API access. Use this to analyze reply volume trends and patterns.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Ticket

**Slug:** `SUPPORTBEE_GET_TICKET`

Tool to retrieve a specific SupportBee ticket by its ID. Returns complete ticket details including subject, content, requester, assignee, labels, and reply/comment counts. Use when you need to fetch full details of a single ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the ticket to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tickets Count Report

**Slug:** `SUPPORTBEE_GET_TICKETS_COUNT_REPORT`

Tool to get ticket count data points over time. Use when analyzing ticket volume trends within a specific date range. Supports optional filtering by agent, team, or label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `label` | string | No | Filter results by label name (optional) |
| `team_id` | integer | No | Filter results by team ID (optional) |
| `to_date` | string | Yes | End date of the report period in YYYY-MM-DD format |
| `agent_id` | integer | No | Filter results by agent ID (optional) |
| `from_date` | string | Yes | Start date of the report period in YYYY-MM-DD format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ticket Comments

**Slug:** `SUPPORTBEE_LIST_TICKET_COMMENTS`

Retrieves all internal comments (private agent notes) for a specific ticket. Comments are visible only to agents within the helpdesk, not to customers. Use this to review internal discussion history on a ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | string | Yes | The unique identifier of the ticket to retrieve comments for. Obtain this from list_tickets or search_tickets actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ticket Replies

**Slug:** `SUPPORTBEE_LIST_TICKET_REPLIES`

Lists all replies on a specific support ticket in SupportBee. Returns reply content, replier details, timestamps, and attachments. Use this to view the conversation history on a ticket. Returns an empty list if the ticket has no replies yet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number to retrieve (1-indexed). Use with per_page for paginated results. |
| `per_page` | integer | No | Number of replies to return per page. Useful for pagination when a ticket has many replies. |
| `ticket_id` | string | Yes | The unique ID of the ticket to fetch replies for. Use SUPPORTBEE_LIST_TICKETS or SUPPORTBEE_SEARCH_TICKETS to find valid ticket IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tickets

**Slug:** `SUPPORTBEE_LIST_TICKETS`

Tool to list tickets from SupportBee. Returns a paginated list of tickets with optional filters for spam, trash, archived, assigned user/group, labels, and more. Use when you need to retrieve and browse tickets in the helpdesk.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (default is 1). |
| `spam` | boolean | No | If true, retrieves tickets marked as spam. Defaults to false. |
| `label` | string | No | Filter tickets by a specific label name. |
| `trash` | boolean | No | If true, retrieves tickets marked as trash. Defaults to false. |
| `replies` | boolean | No | If true, filter tickets that have replies. If false, filter tickets without replies. |
| `starred` | boolean | No | If true, retrieves only starred tickets. |
| `archived` | boolean | No | If true, retrieves archived tickets. Defaults to false. |
| `per_page` | integer | No | Number of tickets per page (default is 15, max is 100). |
| `since_id` | integer | No | Return tickets with ID greater than this value. |
| `assigned_user` | string | No | Filter by assigned user. Use 'me' for current user, 'none' for unassigned, or provide agent ID. |
| `assigned_group` | string | No | Filter by assigned group/team. Use 'mine' for current user's groups or provide group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SupportBee Users

**Slug:** `SUPPORTBEE_LIST_USERS`

Retrieves all users and customer groups in your SupportBee company. Use this when you need to list team members, filter by user type (agents/admins vs customer groups), or include invited users who haven't confirmed their accounts yet.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter users by type. Use 'user' to get only agents/admins, or 'customer_group' to get only customer groups. Omit to get all types. |
| `with_roles` | boolean | No | If true, includes role information for each user in the response. Defaults to false. |
| `with_invited` | boolean | No | If true, returns all agents including invited (unconfirmed) agents who haven't accepted their invitation yet. Defaults to false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark SupportBee Ticket as Answered

**Slug:** `SUPPORTBEE_MARK_TICKET_AS_ANSWERED`

Marks a SupportBee ticket as answered by adding the 'answered' status. Use this after sending a response to a customer to indicate the ticket has been addressed. This action is idempotent - calling it on an already answered ticket has no adverse effect.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique numeric ID of the ticket to mark as answered. Obtain this from list_tickets or create_ticket actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark SupportBee Ticket as Spam

**Slug:** `SUPPORTBEE_MARK_TICKET_AS_SPAM`

Tool to mark a SupportBee ticket as spam. Use when you need to flag unwanted or malicious ticket submissions after obtaining the ticket ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The numeric ID of the SupportBee ticket to mark as spam. Can be provided as string or integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark SupportBee Ticket as Unanswered

**Slug:** `SUPPORTBEE_MARK_TICKET_AS_UNANSWERED`

Marks a SupportBee ticket as unanswered by removing its 'answered' status. Use this to revert a ticket's status after it was previously marked as answered, typically when additional follow-up is needed from the support team. This action is idempotent - calling it on an already unanswered ticket has no adverse effect.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique numeric ID of the ticket to mark as unanswered. Obtain this from list_tickets or create_ticket actions. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Label From Ticket

**Slug:** `SUPPORTBEE_REMOVE_LABEL_FROM_TICKET`

Tool to remove a label from a ticket. Use when you need to unlabel or uncategorize a ticket by removing an existing label.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | Unique numeric ID of the ticket to remove the label from. |
| `label_name` | string | Yes | Name of the label to remove from the ticket. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search SupportBee Tickets

**Slug:** `SUPPORTBEE_SEARCH_TICKETS`

Tool to search SupportBee tickets. Use when you need to find tickets by query with pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Defaults to 1. |
| `spam` | boolean | No | If true, include tickets marked as spam. Defaults to false. |
| `query` | string | No | Search query string to match tickets. Searches in ticket subject, content, and requester info. |
| `trash` | boolean | No | If true, include tickets that are trashed. Defaults to false. |
| `replies` | boolean | No | If true, return only tickets with replies. |
| `archived` | string ("true" | "false" | "any") | No | Filter by archived status: 'true' for only archived, 'false' for non-archived (default), 'any' to include all. |
| `per_page` | integer | No | Number of tickets per page (1-100). Defaults to 15. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Show Ticket Reply

**Slug:** `SUPPORTBEE_SHOW_TICKET_REPLY`

Tool to fetch a specific reply for a SupportBee ticket. Use when you need details of a single reply by ticket and reply IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reply_id` | integer | Yes | ID of the reply to retrieve |
| `ticket_id` | string | Yes | ID of the ticket to fetch the reply for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Show SupportBee User or Customer Group

**Slug:** `SUPPORTBEE_SHOW_USER_OR_CUSTOMER_GROUP`

Retrieves details of a SupportBee user (agent/admin) or customer group by their ID. Use this action when you need to fetch profile information like name, email, role, or timestamps for a specific user whose ID you already have (e.g., from a ticket response).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The numeric ID of the SupportBee user or customer group. You can obtain this ID from ticket responses, team member lists, or the SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUP action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Trash SupportBee Ticket

**Slug:** `SUPPORTBEE_TRASH_TICKET`

Tool to trash a SupportBee ticket by its ID. Use when you need to remove a ticket into the trash folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The numeric ID of the ticket to trash. The ticket will be moved to the trash folder. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive SupportBee Ticket

**Slug:** `SUPPORTBEE_UNARCHIVE_TICKET`

Tool to unarchive a SupportBee ticket by its ID. Use when you need to restore an archived ticket back to active status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The numeric ID of the ticket to unarchive. If the ticket is already unarchived, the operation succeeds idempotently. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign Ticket from Team

**Slug:** `SUPPORTBEE_UNASSIGN_TICKET_FROM_TEAM`

Tool to un-assign a ticket from its assigned team. Use when you need to remove the current team ownership before reassigning or closing the ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | ID of the ticket to remove from its assigned team |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unassign User From Ticket

**Slug:** `SUPPORTBEE_UNASSIGN_TICKET_FROM_USER`

Tool to un-assign a ticket from its assigned user/agent. Use when you need to remove the current user ownership before reassigning to a different user or closing the ticket.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticket_id` | integer | Yes | ID of the ticket to remove the assigned user from |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unmark SupportBee Ticket as Spam

**Slug:** `SUPPORTBEE_UNMARK_TICKET_AS_SPAM`

Tool to unmark a SupportBee ticket as spam. Use when a ticket was incorrectly flagged as spam.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The numeric ID of the SupportBee ticket to unmark as spam. Can be provided as string or integer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Untrash SupportBee Ticket

**Slug:** `SUPPORTBEE_UNTRASH_TICKET`

Restores a trashed SupportBee ticket back to active status. Use when you need to recover a ticket that was previously moved to trash.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The numeric ID of the trashed ticket to restore. The ticket must currently be in the trash. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Snippet

**Slug:** `SUPPORTBEE_UPDATE_SNIPPET`

Update an existing snippet (canned response) in SupportBee. Use this to modify the name, content, or tags of a snippet. To find snippet IDs, use the 'Fetch Snippets' action first.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique ID of the snippet to update. You can obtain snippet IDs by calling the 'Fetch Snippets' action first. |
| `name` | string | Yes | The name/title for the snippet. This will be displayed when selecting snippets. |
| `tags` | string | No | Comma-separated tags to categorize the snippet (e.g., 'refund, policy, updated'). |
| `content` | object | Yes | The content of the snippet. Must include at least text or html. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SupportBee User

**Slug:** `SUPPORTBEE_UPDATE_USER`

Update an existing SupportBee user's profile information including name, email, role, avatar, or signature. This action modifies user account details via the SupportBee API. You can update one or multiple fields in a single request. Commonly used to change user roles (agent/admin), update contact information, or customize user profiles. Requirements: - Valid user ID (obtain from SUPPORTBEE_CREATE_USER_OR_CUSTOMER_GROUP or other user-related actions) - At least one field to update (name, email, role, avatar_url, or signature) Common use cases: - Promote an agent to admin by updating the role field - Update user email addresses when they change - Customize user signatures for support ticket replies

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique numeric ID of the SupportBee user to update. Required. |
| `name` | string | No | Updated display name for the user. If provided, replaces the current name. |
| `role` | string ("agent" | "admin") | No | Updated role for the user. Use 'agent' for regular team members or 'admin' for administrators with full permissions. |
| `email` | string | No | Updated email address for the user. Must be a valid email format. |
| `signature` | string | No | Updated email signature for the user. This will appear at the end of their support replies. |
| `avatar_url` | string | No | URL to an image to use as the user's avatar. Must be a publicly accessible URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | object | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |
