---
canonical_url: "https://docs.composio.dev/toolkits/front"
markdown_url: "https://docs.composio.dev/toolkits/front.md"
product: "platform"
version: null
last_updated: null
---

# Front

Front is a shared inbox and collaboration platform that centralizes customer communications from multiple channels, enabling teams to manage emails, chats, and more

- **Category:** customer support
- **Auth:** API_KEY, OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 180
- **Triggers:** 0
- **Slug:** `FRONT`
- **Version:** 20261026_00

## Tools

### Add Comment

**Slug:** `FRONT_ADD_COMMENT`

Add a comment to a conversation or reply to an existing comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Content of the comment. Can include markdown formatting. |
| `author_id` | string | No | ID of the teammate creating the comment. Alternatively, you can supply the author as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). If omitted, will post as the API Token or OAuth client of the requester. |
| `is_pinned` | boolean | No | Whether or not the comment is pinned in its conversation. |
| `comment_id` | string | No | Required only when `target_type` is `comment`; forbidden when it is `conversation`. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `target_type` | string ("conversation" | "comment") | Yes | Comment target. `conversation` requires only `conversation_id` and forbids `comment_id`; `comment` requires only `comment_id` and forbids `conversation_id`. |
| `conversation_id` | string | No | Required only when `target_type` is `conversation`; forbidden when it is `comment`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add teammate group team inboxes

**Slug:** `FRONT_ADD_COMPANY_TEAMMATE_GROUP_TEAM_INBOXES`

Links non-public inboxes to the teammate group. The inbox must be part of a team that has been added to the teammate group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_ids` | array | Yes | IDs of the non-public team inboxes to link to the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add teammate group teammates

**Slug:** `FRONT_ADD_COMPANY_TEAMMATE_GROUP_TEAMMATES`

Add teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_ids` | array | Yes | IDs of the teammates to add to the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add teammate group teams

**Slug:** `FRONT_ADD_COMPANY_TEAMMATE_GROUP_TEAMS`

Adds teams to the teammate group. Any teams added to the teammate group will automatically link public inboxes. Non-public inboxes can be added to the teammate group separately.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_ids` | array | Yes | IDs of the teams to add to the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add contact handle

**Slug:** `FRONT_ADD_CONTACT_HANDLE`

Add an email, phone, Twitter, Facebook, Intercom, Front Chat, or custom handle to an existing contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle used to reach the contact. |
| `source` | string ("twitter" | "email" | "phone" | "facebook" | "intercom" | "front_chat" | "custom") | Yes | Source of the handle. Can be `email`, `phone`, `twitter`, `facebook`, `intercom`, `front_chat`, or `custom`. |
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add contacts to contact list

**Slug:** `FRONT_ADD_CONTACTS_TO_CONTACT_LIST`

Add multiple existing contacts, identified by contact ID or source-and-handle resource alias, to a contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_ids` | array | Yes | List of IDs of the contacts to add in the requested contact list. Alternatively, you can supply the contact source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `contact_list_id` | string | Yes | The contact list ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add contact to Account

**Slug:** `FRONT_ADD_CONTACT_TO_ACCOUNT`

Adds a list of contacts to an Account

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `contact_ids` | array | Yes | The contact IDs to include. Alternatively, you can supply the contact source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add conversation followers

**Slug:** `FRONT_ADD_CONVERSATION_FOLLOWERS`

Add one or more teammates as followers of an existing conversation, optionally ignoring invalid teammate IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_ids` | array | Yes | IDs of the teammate to add to the followers list. Alternatively, you can supply the teammates as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `ignore_errors` | boolean | No | Whether to ignore invalid teammate IDs and continue adding valid ones. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add conversation link

**Slug:** `FRONT_ADD_CONVERSATION_LINK`

Associate existing links with a conversation, or create links from external URLs when needed and associate them.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_ids` | array | No | Link IDs to add. Either link_ids or link_external_urls must be specified but not both |
| `conversation_id` | string | Yes | The conversation ID |
| `link_external_urls` | array | No | Link external URLs to add. Creates links if necessary. Either link_ids or link_external_urls must be specified but not both |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add conversation tag

**Slug:** `FRONT_ADD_CONVERSATION_TAG`

Attach one or more existing tags, identified by tag ID, to a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | IDs of the tags to add to the conversation. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add inbox access

**Slug:** `FRONT_ADD_INBOX_ACCESS`

Grant specified teammates access to an existing inbox.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | The Inbox ID |
| `teammate_ids` | array | Yes | IDs of the teammates to grant access to the inbox. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add note

**Slug:** `FRONT_ADD_NOTE`

Create a new note on a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Content of the note |
| `author_id` | string | Yes | ID of teammate creating the note |
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add teammates to shift

**Slug:** `FRONT_ADD_TEAMMATES_TO_SHIFT`

Add teammates to a shift. The selected teammates must be in the team that owns the shift. Requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shift_id` | string | Yes | The Shift ID |
| `teammate_ids` | array | Yes | IDs of the teammates to add to the shift. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add teammates to team

**Slug:** `FRONT_ADD_TEAMMATES_TO_TEAM`

Add one or more teammates to a team (workspace).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The Team ID |
| `teammate_ids` | array | Yes | IDs of the teammates to add to the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Add view to teammate sidebars

**Slug:** `FRONT_ADD_VIEW_TEAMMATES`

Makes this view visible in specified teammates' sidebar navigation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | The view ID |
| `teammate_ids` | array | Yes | IDs of teammates whose sidebar should display the view. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 account

**Slug:** `FRONT_CREATE_ACCOUNT`

Create a Front account with optional domains, external ID, description, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the Account |
| `domains` | array | No | List of domains associated with the Account |
| `description` | string | No | Account description |
| `external_id` | string | No | ID of the Account in an external system |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a new analytics export

**Slug:** `FRONT_CREATE_ANALYTICS_EXPORT`

Create a new analytics export of messages or events (activities) over a specific time span. The export will be executed asynchronously. The response will include a link that can be used to retrieve the export status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | number | Yes | End time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded up to the end of the day. |
| `type` | string ("messages" | "events") | Yes | The type of export to create. The type you specify determines which columns are available for the export. |
| `start` | number | Yes | Start time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded down to the start of the day. |
| `columns` | array | Yes | Columns to include. Message exports accept documented message-column names. Event exports also accept parameterized `{name, id}` columns for ticket statuses, Smart QA criteria, and custom fields. |
| `filters` | object | No | Resource filters. Supported keys are `tag_ids`, `teammate_ids`, `channel_ids`, `inbox_ids`, `team_ids`, and `account_ids`; each value is a list of Front resource IDs. Defaults to all resources. |
| `timezone` | string | No | [IANA name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the timezone to format the dates with. If omitted, the export will use Etc/UTC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a new analytics report

**Slug:** `FRONT_CREATE_ANALYTICS_REPORT`

Create a new analytics report for a set of metrics over a specific time span. Different filters (e.g. Inbox v Tag v Teammates) will be joined with AND logic, but the IDs within a filter will be joined with OR logic (e.g. Inbox A or Inbox B, Tag A or Tag B). The report will be executed asynchronously. The response will include a link that can be used to retrieve the report status & result. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end` | number | Yes | End time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded up to the end of the day. |
| `start` | number | Yes | Start time of the data to include in the export (seconds since 1970-01-01T00:00:00+00). Will be rounded down to the start of the day. |
| `filters` | object | No | Resource filters. Supported keys are `tag_ids`, `teammate_ids`, `channel_ids`, `inbox_ids`, `team_ids`, and `account_ids`; each value is a list of Front resource IDs. Different keys are joined with AND and IDs within one key with OR. Defaults to all resources. |
| `metrics` | array | Yes | List of the metrics required. |
| `timezone` | string | No | [IANA name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of the timezone to format the dates with. If omitted, the export will use Etc/UTC. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a channel

**Slug:** `FRONT_CREATE_CHANNEL`

Create a custom, SMTP, Twilio, or developer-application channel in an existing inbox.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the channel |
| `type` | string ("custom" | "smtp" | "twilio") | Yes | Type of the channel |
| `send_as` | string | No | Sending address of your channel. Required for SMTP and Twilio channels. |
| `inbox_id` | string | Yes | The Inbox ID |
| `settings` | object | No | Settings of the channel |
| `credentials` | object | No | Credentials used to authenticate requests to the application's service. Only used with `application_uid`, and its shape depends on the application server's authentication type:   - `none`: omit.   - `api_key`: `{ "api_key": string }`.   - `basic`: `{ "username": string, "password": string }`.   - `bearer`: `{ "access_token": string }`.   - OAuth2 `client_credentials`: `{ "client_id": string, "client_secret": string }`   - OAuth2 `password`: `{ "username": string, "password": string }`   - OAuth2 `authorization_code`: omit. The channel is created unauthenticated and the OAuth     flow must be completed interactively afterwards.  |
| `application_uid` | string | No | The UID of a developer app that defines a channel. When provided, an application channel bound to that app is created (the channel `type` must be "custom").  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 child template

**Slug:** `FRONT_CREATE_CHILD_MESSAGE_TEMPLATE`

Create a new message template as a child of the given folder

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the message template. You can supply HTML with inline CSS to structure and style your template. |
| `name` | string | Yes | Name of the message template |
| `subject` | string | No | Subject of the message template. |
| `inbox_ids` | array | No | The specific inboxes this template is available in. If unspecified or null, then it will be available in all inboxes. Array should be non-empty. |
| `message_template_folder_id` | string | Yes | The parent message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 child folder

**Slug:** `FRONT_CREATE_CHILD_MESSAGE_TEMPLATE_FOLDER`

Create a new message template folder as a child of the given folder

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the message template folder |
| `message_template_folder_id` | string | Yes | The parent message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group

**Slug:** `FRONT_CREATE_COMPANY_TEAMMATE_GROUP`

Create a company teammate group with an optional description and contact-list permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the teammate group |
| `description` | string | No | Description of the teammate group |
| `permissions` | object | No | Permissions for the teammate group |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Contact

**Slug:** `FRONT_CREATE_CONTACT`

Create a contact globally or for one team or teammate. Supplying named groups or contact lists also creates any that are missing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Contact name |
| `links` | array | No | List of all the links of the contact |
| `avatar` | object | No | Avatar image upload, up to 25 MB. |
| `handles` | array | Yes | List of the handles for this contact. Each handle object should include `handle` and `source` fields. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `list_names` | array | No | List of all the contact list names the contact belongs to. It will automatically create missing groups |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Contact owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `description` | string | No | Contact description |
| `group_names` | array | No | List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use `list_names` instead. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Contact List

**Slug:** `FRONT_CREATE_CONTACT_LIST`

Create a contact list globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the contact list |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Contact-list owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 discussion/task conversation

**Slug:** `FRONT_CREATE_CONVERSATION`

Create a new [conversation](https://dev.frontapp.com/reference/conversations#creating-a-new-conversation) of type discussion or task. Both types only support comments. If you want to create a conversation that supports messages, use the [Create message](https://dev.frontapp.com/reference/post_channels-channel-id-messages) endpoint. If you want to add a comment to an existing conversation, use the [Add comment](https://dev.frontapp.com/reference/post_conversations-conversation-id-comments) endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("discussion" | "task") | Yes | Conversation type |
| `due_at` | number | No | Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed when type is `task`. |
| `comment` | object | No | Details for the starter comment. Required for discussions, optional for tasks. |
| `subject` | string | Yes | Subject of the conversation. Used as the title for tasks. |
| `inbox_id` | string | No | Inbox ID for the conversation. Either `inbox_id` OR `teammate_ids` must be provided (not both). |
| `description` | string | No | Description of the task. Only allowed when type is `task`. |
| `teammate_ids` | array | No | Teammates to add to the conversation. Either `inbox_id` OR `teammate_ids` must be provided (not both). |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 draft

**Slug:** `FRONT_CREATE_DRAFT`

Create a draft message which is the first message of a new [conversation](https://dev.frontapp.com/reference/conversations).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of recipient handles who will receive a copy of the message once the draft is sent |
| `to` | array | No | List of recipient handles who will receive the message once the draft is sent |
| `bcc` | array | No | List of the recipient handles who will receive a blind copy of the message once the draft is sent |
| `body` | string | Yes | Body of the draft |
| `mode` | string ("private" | "shared") | No | Mode of the draft to create. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation). |
| `subject` | string | No | Subject of the draft. |
| `author_id` | string | No | ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). If omitted, will post as the API Token or Application making the request. |
| `channel_id` | string | Yes | The channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `quote_body` | string | No | Body for the quote that the message is referencing. Only available on email channels. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `signature_id` | string | No | ID of the signature to attach to this draft. If null, no signature is attached. |
| `should_add_default_signature` | boolean | No | Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false; |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 draft reply

**Slug:** `FRONT_CREATE_DRAFT_REPLY`

Create a new draft as a reply to the last message in the conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of recipient handles who will receive a copy of the message once the draft is sent |
| `to` | array | No | List of recipient handles who will receive the message once the draft is sent |
| `bcc` | array | No | List of the recipient handles who will receive a blind copy of the message once the draft is sent |
| `body` | string | Yes | Body of the draft |
| `mode` | string ("private" | "shared") | No | Mode of the draft to create. Can be 'private' (draft is visible to the author only) or 'shared' (draft is visible to all teammates with access to the conversation). |
| `subject` | string | No | Subject of the draft. |
| `author_id` | string | No | ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). If omitted, will post as the API Token or Application making the request. |
| `channel_id` | string | Yes | ID of the channel from which the draft will be sent. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `quote_body` | string | No | Body for the quote that the message is referencing. Only available on email channels. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `signature_id` | string | No | ID of the signature to attach to this draft. If null, no signature is attached. |
| `conversation_id` | string | Yes | The conversation ID |
| `should_add_default_signature` | boolean | No | Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false; |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 inbox

**Slug:** `FRONT_CREATE_INBOX`

Create an inbox in the oldest active workspace that the token has access to. If you need to specify the workspace, we recommend using the [Create team inbox](https://dev.frontapp.com/reference/create-team-inbox) endpoint instead.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the inbox |
| `is_public` | boolean | No | Whether the inbox is public or not |
| `teammate_ids` | array | No | An array of teammate IDs that should have access to the inbox. Alternatively, you can supply teammate emails as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a knowledge base

**Slug:** `FRONT_CREATE_KNOWLEDGE_BASE`

Create an internal company-only or externally available knowledge base.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the knowledge base |
| `type` | string ("internal" | "external") | No | Determines if the knowledge base is publicly available or private only to your company |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Article

**Slug:** `FRONT_CREATE_KNOWLEDGE_BASE_ARTICLE`

Create an article in a knowledge base's default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the article's content |
| `status` | string ("draft" | "published") | No | Article status |
| `content` | string | Yes | HTML content of the article |
| `subject` | string | Yes | Subject of the article |
| `author_id` | string | Yes | Teammate ID of the article author |
| `category_id` | string | No | ID of the category this article belongs to |
| `knowledge_base_id` | string | Yes | The ID of the knowledge base to create the article in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Category

**Slug:** `FRONT_CREATE_KNOWLEDGE_BASE_CATEGORY`

Create a category in a knowledge base's default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the knowledge base category |
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the category's content |
| `description` | string | No | Description of the knowledge base category |
| `knowledge_base_id` | string | Yes | The ID of the knowledge base to create the category in |
| `parent_category_id` | string | No | ID of the parent category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Message Template

**Slug:** `FRONT_CREATE_MESSAGE_TEMPLATE`

Create a message template globally or for one team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the message template. You can supply HTML with inline CSS to structure and style your template. |
| `name` | string | Yes | Name of the message template |
| `subject` | string | No | Subject of the message template. |
| `team_id` | string | No | Required for `owner_type=team`; forbidden for `owner_type=global`. |
| `folder_id` | string | No | ID of the message template folder to place this message template in |
| `inbox_ids` | array | No | The specific inboxes this template is available in. If unspecified or null, then it will be available in all inboxes. Array should be non-empty. |
| `owner_type` | string ("global" | "team") | Yes | Template owner. `global` forbids `team_id`; `team` requires `team_id`. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Message Template Folder

**Slug:** `FRONT_CREATE_MESSAGE_TEMPLATE_FOLDER`

Create a message-template folder globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the message template folder |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Folder owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |
| `parent_folder_id` | string | No | ID of the parent folder to be placed into. Goes into the root folder if unspecified or if null. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Shift

**Slug:** `FRONT_CREATE_SHIFT`

Create a global or team-owned shift; requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the shift |
| `color` | string ("black" | "grey" | "pink" | "purple" | "blue" | "teal" | "green" | "yellow" | "orange" | "red") | Yes | Color of the shift |
| `times` | object | Yes | Shift intervals by weekday. Each included day requires `start` and `end` strings interpreted in `timezone`. |
| `team_id` | string | No | Required for `owner_type=team`; forbidden for `owner_type=global`. |
| `timezone` | string | Yes | A timezone name as defined in the IANA tz database |
| `owner_type` | string ("global" | "team") | Yes | Shift owner. `global` forbids `team_id`; `team` requires `team_id`. |
| `teammate_ids` | array | Yes | List of all the teammate ids who will be part of this shift. Alternatively, you can supply emails as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 standard link

**Slug:** `FRONT_CREATE_STANDARD_LINK`

Create a standard link from an external URL. If the link resolves to an installed links integration, the integration's name overrides the provided name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the link. If none is specified, the external_url is used as a default |
| `external_url` | string | Yes | Underlying identifying URL of the standard link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tag

**Slug:** `FRONT_CREATE_TAG`

Create a tag globally, company-wide, under a parent tag, or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the tag |
| `tag_id` | string | No | Required only for `owner_type=parent_tag`; forbidden for every other owner type. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for every other owner type. |
| `highlight` | string ("grey" | "pink" | "red" | "orange" | "yellow" | "green" | "light-blue" | "blue" | "purple") | No | Highlight color of the tag. |
| `owner_type` | string ("global" | "company" | "parent_tag" | "team" | "teammate") | Yes | Tag owner or parent. `global` and `company` forbid all route IDs; `parent_tag` requires only `tag_id`; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `description` | string | No | Description of the tag |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for every other owner type. A teammate email resource alias is accepted. |
| `is_visible_in_conversation_lists` | boolean | No | Whether the tag is visible in conversation lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 team inbox

**Slug:** `FRONT_CREATE_TEAM_INBOX`

Create a team inbox and optionally configure teammate access, public visibility, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the inbox |
| `team_id` | string | Yes | The team ID |
| `is_public` | boolean | No | Whether the inbox is public or not |
| `teammate_ids` | array | No | An array of teammate IDs that should have access to the inbox. Alternatively, you can supply teammate emails as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate message template

**Slug:** `FRONT_CREATE_TEAMMATE_MESSAGE_TEMPLATE`

Create a teammate-owned message template, optionally inside a message-template folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the message template. You can supply HTML with inline CSS to structure and style your template. |
| `name` | string | Yes | Name of the message template |
| `subject` | string | No | Subject of the message template. |
| `folder_id` | string | No | ID of the message template folder to place this message template in |
| `teammate_id` | string | Yes | The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate private inbox

**Slug:** `FRONT_CREATE_TEAMMATE_PRIVATE_INBOX`

Create a private inbox owned by a specified teammate, with optional custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the inbox |
| `teammate_id` | string | Yes | The teammate ID |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate signature

**Slug:** `FRONT_CREATE_TEAMMATE_SIGNATURE`

Create a teammate email signature and optionally make it the default or limit it to selected channels.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the signature |
| `name` | string | Yes | Name of the signature |
| `is_default` | boolean | No | If true, the signature will be set as the default signature for the teammate. |
| `channel_ids` | array | No | The specific channels this signature is available in. If omitted or null, the signature will be available in all channels the teammate has access to. Alternatively, you can specify channels using a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `sender_info` | string | No | Sender info of the signature that will appear in the From line of emails sent. |
| `teammate_id` | string | Yes | The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 team signature

**Slug:** `FRONT_CREATE_TEAM_SIGNATURE`

Create a team email signature and optionally configure default status and channel visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the signature |
| `name` | string | Yes | Name of the signature |
| `team_id` | string | Yes | The team ID |
| `is_default` | boolean | No | If true, the signature will be set as the default signature for the team. |
| `channel_ids` | array | No | The specific channels this signature is available in. If omitted or null, the signature will be available in all channels the team has access to. Alternatively, you can specify channels using a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `sender_info` | string | No | Sender info of the signature that will appear in the From line of emails sent. |
| `is_visible_for_all_teammate_channels` | boolean | No | Whether or not the signature is visible in all individual channels for teammates in the given team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 team view

**Slug:** `FRONT_CREATE_TEAM_VIEW`

Create a team conversation view filtered by inboxes, tags, assignees, and optional exclusions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the view |
| `no_tags` | boolean | No | Whether to filter for conversations without tags |
| `tag_ids` | array | No | List of tag IDs to filter by |
| `team_id` | string | Yes | The team ID |
| `highlight` | string | No | Color highlight for the view |
| `inbox_ids` | array | Yes | List of inbox IDs to filter by |
| `not_tag_ids` | array | No | List of tag IDs to exclude |
| `assignee_ids` | array | No | List of assignee IDs to filter by |
| `not_assignee_ids` | array | No | List of assignee IDs to exclude |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 time off

**Slug:** `FRONT_CREATE_TIME_OFF`

Create a time off for a teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the time off |
| `end_at` | number | No | Timestamp when the time off ends (in seconds), or null if open-ended |
| `start_at` | number | Yes | Timestamp when the time off starts (in seconds) |
| `teammate_id` | string | Yes | The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `auto_responder` | object | No | Optional auto-responder settings: message `body`, `is_enabled`, `is_contacts_only`, and applicable `channel_ids`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 an account

**Slug:** `FRONT_DELETE_ACCOUNT`

Deletes an account This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group

**Slug:** `FRONT_DELETE_COMPANY_TEAMMATE_GROUP`

Deletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a contact

**Slug:** `FRONT_DELETE_CONTACT`

Delete a contact. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contact handle

**Slug:** `FRONT_DELETE_CONTACT_HANDLE`

Remove a handle from a contact. If `force` is true and this is the last handle, Front permanently deletes the entire contact; this cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `force` | boolean | No | If true and this is the contact's last handle, permanently delete the entire contact. |
| `handle` | string | Yes | Handle used to reach the contact. |
| `source` | string ("twitter" | "email" | "phone" | "facebook" | "intercom" | "front_chat" | "custom") | Yes | Source of the handle. Can be `email`, `phone`, `twitter`, `facebook`, `intercom`, `front_chat`, or `custom`. |
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contact list

**Slug:** `FRONT_DELETE_CONTACT_LIST`

Delete a contact lists. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_list_id` | string | Yes | The contact list ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation

**Slug:** `FRONT_DELETE_CONVERSATION`

Permanently delete a conversation. First use Update conversation to set its status to "deleted"; setting it to "archived" is not sufficient. This action cannot be undone. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 draft

**Slug:** `FRONT_DELETE_DRAFT`

Delete a draft message. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `version` | string | Yes | Version of the draft |
| `draft_id` | string | Yes | The draft ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 an article

**Slug:** `FRONT_DELETE_KNOWLEDGE_BASE_ARTICLE`

Deletes an article and all its content and translations. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | The ID of the article to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a knowledge base category

**Slug:** `FRONT_DELETE_KNOWLEDGE_BASE_CATEGORY`

Deletes a knowledge base category. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | The ID of the category to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message template

**Slug:** `FRONT_DELETE_MESSAGE_TEMPLATE`

Delete a message template This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_template_id` | string | Yes | The message template ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 folder

**Slug:** `FRONT_DELETE_MESSAGE_TEMPLATE_FOLDER`

Delete a message template folder and child folders/templates This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_template_folder_id` | string | Yes | The message template folder id |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 signature

**Slug:** `FRONT_DELETE_SIGNATURE`

Delete signature This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signature_id` | string | Yes | The signature ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 tag

**Slug:** `FRONT_DELETE_TAG`

Delete a tag. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The ID of the tag to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 time off

**Slug:** `FRONT_DELETE_TIME_OFF`

Delete a time off. This permanently deletes the resource.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `time_off_id` | string | Yes | The time off ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Download attachment from an article

**Slug:** `FRONT_DOWNLOAD_ARTICLE_ATTACHMENT`

Download one article attachment by article ID and attachment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | The ID of the article |
| `attachment_id` | string | Yes | The ID of the file to download |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Download Attachment

**Slug:** `FRONT_DOWNLOAD_ATTACHMENT`

Download an attachment by its link ID, optionally constrained to its comment, message, or message-template parent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | string | No | Required only for `parent_type=comment`; forbidden for every other location. |
| `message_id` | string | No | Required only for `parent_type=message`; forbidden for every other location. |
| `parent_type` | string ("none" | "comment" | "message" | "message_template") | Yes | Attachment location. `none` requires only `attachment_link_id`; `comment`, `message`, and `message_template` additionally require only their matching parent ID and forbid the other parent IDs. |
| `attachment_link_id` | string | Yes | Required for every `parent_type`; the attachment link ID. |
| `message_template_id` | string | No | Required only for `parent_type=message_template`; forbidden for every other location. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 an account

**Slug:** `FRONT_GET_ACCOUNT`

Retrieve one account by account ID, domain, or external-ID resource alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 an analytics export

**Slug:** `FRONT_GET_ANALYTICS_EXPORT`

Fetch an analytics exports. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `export_id` | string | Yes | The export ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 an analytics report

**Slug:** `FRONT_GET_ANALYTICS_REPORT`

Fetch an analytics report. Refer to the [Analytics](https://dev.frontapp.com/reference/analytics) topic for details about specific metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `report_uid` | string | Yes | The report UID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 channel

**Slug:** `FRONT_GET_CHANNEL`

Retrieve one channel by channel ID or channel-address resource alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 comment

**Slug:** `FRONT_GET_COMMENT`

Retrieve one conversation comment by comment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | string | Yes | The Comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group

**Slug:** `FRONT_GET_COMPANY_TEAMMATE_GROUP`

Retrieve one company teammate group by group ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contact

**Slug:** `FRONT_GET_CONTACT`

Retrieve one contact by contact ID or source-and-handle resource alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation

**Slug:** `FRONT_GET_CONVERSATION`

Retrieve one conversation by conversation ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### API Token details

**Slug:** `FRONT_GET_CURRENT_IDENTITY`

Fetch the details of the API token.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 event

**Slug:** `FRONT_GET_EVENT`

Retrieve one event by event ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_id` | string | Yes | The event ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 inbox

**Slug:** `FRONT_GET_INBOX`

Retrieve one inbox by inbox ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | The Inbox ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a knowledge base

**Slug:** `FRONT_GET_KNOWLEDGE_BASE`

Retrieve knowledge-base metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_CONTENT` to retrieve localized content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `knowledge_base_id` | string | Yes | The ID of the knowledge base to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a knowledge base article

**Slug:** `FRONT_GET_KNOWLEDGE_BASE_ARTICLE`

Retrieve article metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_ARTICLE_CONTENT` to retrieve default- or selected-locale content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `article_id` | string | Yes | The ID of the article to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Article Content

**Slug:** `FRONT_GET_KNOWLEDGE_BASE_ARTICLE_CONTENT`

Get a knowledge-base article with content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |
| `article_id` | string | Yes | The ID of the article to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a knowledge base category

**Slug:** `FRONT_GET_KNOWLEDGE_BASE_CATEGORY`

Retrieve category metadata without localized content. Use `FRONT_GET_KNOWLEDGE_BASE_CATEGORY_CONTENT` to retrieve default- or selected-locale content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `category_id` | string | Yes | The ID of the category to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Category Content

**Slug:** `FRONT_GET_KNOWLEDGE_BASE_CATEGORY_CONTENT`

Get a knowledge-base category with content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |
| `category_id` | string | Yes | The ID of the category to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Content

**Slug:** `FRONT_GET_KNOWLEDGE_BASE_CONTENT`

Get a knowledge base with content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the content to fetch |
| `knowledge_base_id` | string | Yes | The ID of the knowledge base to fetch |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 link

**Slug:** `FRONT_GET_LINK`

Retrieve one Front link by link ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_id` | string | Yes | The link ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message

**Slug:** `FRONT_GET_MESSAGE`

Retrieve a message as documented JSON, or download the raw email as an EML file when `response_format` is `eml`.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The message ID |
| `response_format` | string ("json" | "eml") | No | Return the documented JSON message, or download an email message as an EML file. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message seen status

**Slug:** `FRONT_GET_MESSAGE_SEEN_STATUS`

Get the seen receipts for the given message. If no seen-by information is available, there will be a single entry for the first time the message was seen by any recipient. If seen-by information is available, there will be an entry for each recipient who has seen the message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The message ID |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message template

**Slug:** `FRONT_GET_MESSAGE_TEMPLATE`

Retrieve one message template by template ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_template_id` | string | Yes | The message template ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 folder

**Slug:** `FRONT_GET_MESSAGE_TEMPLATE_FOLDER`

Fetch a message template folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_template_folder_id` | string | Yes | The message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 rule

**Slug:** `FRONT_GET_RULE`

Retrieve one Front automation rule by rule ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule_id` | string | Yes | The Rule ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 shift

**Slug:** `FRONT_GET_SHIFT`

Fetch a shift. Requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shift_id` | string | Yes | The Shift ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 signatures

**Slug:** `FRONT_GET_SIGNATURE`

Retrieve one email signature by signature ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `signature_id` | string | Yes | The signature ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 tag

**Slug:** `FRONT_GET_TAG`

Retrieve one tag by tag ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The tag ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 team

**Slug:** `FRONT_GET_TEAM`

Fetch a team (workspace).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The Team ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate

**Slug:** `FRONT_GET_TEAMMATE`

Retrieve one teammate by teammate ID or email resource alias.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_id` | string | Yes | The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 status

**Slug:** `FRONT_GET_TICKET_STATUS`

Retrieve one ticket status by status ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `status_id` | string | Yes | The ticket status ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 time off

**Slug:** `FRONT_GET_TIME_OFF`

Retrieve one time-off record by time-off ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `time_off_id` | string | Yes | The time off ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 view

**Slug:** `FRONT_GET_VIEW`

Retrieve one conversation view by view ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view_id` | string | Yes | The view ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Import message

**Slug:** `FRONT_IMPORT_INBOX_MESSAGE`

Use this endpoint to import conversations into Front without sending data through a channel. Typical use cases include importing historical conversations or creating new conversations from non-standard sources, such as web form submissions that can't use the default Form channel (for example, forms that don't have static URLs or form providers that send email notifications after submission). Avoid using this endpoint for conversations that can be handled by a dedicated Front channel—instead, use the [Create message](https://dev.frontapp.com/reference/create-message) endpoint to send (rather than import) a new message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of the recipient handles who will receive a copy of this message |
| `to` | array | Yes | List of the recipient handles who will receive this message |
| `bcc` | array | No | List of the recipient handles who will receive a blind copy of this message |
| `body` | string | Yes | Body of the message |
| `tags` | array | No | List of tag names to add to the conversation |
| `type` | string ("email" | "sms" | "intercom" | "custom") | No | Type of the message to import. Default is `email`. |
| `sender` | object | Yes | Sender details: required `handle`, plus optional `name` and outbound-message `author_id`. |
| `subject` | string | No | Subject of the message |
| `inbox_id` | string | Yes | The Inbox ID |
| `metadata` | object | Yes | Import behavior: required `is_inbound`, plus optional `thread_ref`, `is_archived`, and `should_skip_rules`. |
| `created_at` | integer | Yes | Date at which the message as been sent or received. |
| `assignee_id` | string | No | ID of the teammate who will be assigned to the conversation. |
| `attachments` | array | No | Files to attach to the imported message, up to 25 MB each. Supply each file using the tool's file-upload object. |
| `body_format` | string ("html" | "markdown") | No | Format of the message body. Can be `markdown` (default) or `html`, and can only be specified for `email` type. |
| `external_id` | string | Yes | External identifier of the message. Front won't import two messages with the same external ID. |
| `conversation_id` | string | No | If supplied, Front will thread this message into conversation with the given ID. Note that including this parameter nullifies the `thread_ref` parameter _completely_. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Link conversations

**Slug:** `FRONT_LINK_CONVERSATIONS`

Adds conversations to the link group of the conversation in the path, which becomes the original conversation of the group. If it belongs to no group yet, a new one is formed. A conversation belongs to at most one group, and a conversation that was linked to another one cannot become an original conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |
| `conversation_ids` | array | Yes | IDs of the conversations to link to the conversation in the path. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 account contacts

**Slug:** `FRONT_LIST_ACCOUNT_CONTACTS`

Lists the contacts associated with an Account

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `sort_by` | string ("created_at" | "updated_at") | No | Field used to sort the contacts. Either `created_at` or `updated_at`. |
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Accounts

**Slug:** `FRONT_LIST_ACCOUNTS`

List the accounts of the company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `sort_by` | string ("created_at" | "updated_at") | No | Field used to sort the accounts. Either `created_at` or `updated_at`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 categories in a knowledge base

**Slug:** `FRONT_LIST_CATEGORIES_IN_A_KNOWLEDGE_BASE`

List categories in a knowledge base.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `knowledge_base_id` | string | Yes | The ID of the knowledge base |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Channels

**Slug:** `FRONT_LIST_CHANNELS`

List channels globally or for one inbox, team, or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for every other owner type. |
| `inbox_id` | string | No | Required only for `owner_type=inbox`; forbidden for every other owner type. |
| `owner_type` | string ("company" | "inbox" | "team" | "teammate") | Yes | Channel owner. `company` forbids all route IDs; `inbox` requires only `inbox_id`; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for every other owner type. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 child folders

**Slug:** `FRONT_LIST_CHILD_MESSAGE_TEMPLATE_FOLDERS`

Fetch the child message templates folders of a message template folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `message_template_folder_id` | string | Yes | The message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 child templates

**Slug:** `FRONT_LIST_CHILD_MESSAGE_TEMPLATES`

Fetch the child message templates of a message template folder.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `message_template_folder_id` | string | Yes | The message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 comment mentions

**Slug:** `FRONT_LIST_COMMENT_MENTIONS`

List the teammates mentioned in a comment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment_id` | string | Yes | The Comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate groups

**Slug:** `FRONT_LIST_COMPANY_TEAMMATE_GROUPS`

List company teammate groups with their IDs, names, SCIM-management status, contact-list permissions, and membership links.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group team inboxes

**Slug:** `FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAM_INBOXES`

List inboxes that the teammate group has access to via its associated teams.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group teammates

**Slug:** `FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAMMATES`

List teammates belonging to a specified company teammate group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group teams

**Slug:** `FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAMS`

List teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 company ticket statuses

**Slug:** `FRONT_LIST_COMPANY_TICKET_STATUSES`

List company ticket statuses with their IDs, names, and categories for resolving valid status IDs.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Contact Lists

**Slug:** `FRONT_LIST_CONTACT_LISTS`

List contact lists globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Contact-list owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 notes

**Slug:** `FRONT_LIST_CONTACT_NOTES`

List the notes added to a contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Contacts

**Slug:** `FRONT_LIST_CONTACTS`

List contacts globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `updated_after` and `updated_before`, whose value should be a timestamp in seconds with up to 3 decimal places. |
| `sort_by` | string ("created_at" | "updated_at") | No | Field used to sort the contacts. Either `created_at` or `updated_at`. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Contact owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contacts in contact list

**Slug:** `FRONT_LIST_CONTACTS_IN_CONTACT_LIST`

List the contacts belonging to the requested contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `contact_list_id` | string | Yes | The contact list ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation comments

**Slug:** `FRONT_LIST_CONVERSATION_COMMENTS`

List the comments in a conversation in reverse chronological order (newest first).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation drafts

**Slug:** `FRONT_LIST_CONVERSATION_DRAFTS`

List draft messages in a conversation with cursor-based pagination.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation events

**Slug:** `FRONT_LIST_CONVERSATION_EVENTS`

List the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation followers

**Slug:** `FRONT_LIST_CONVERSATION_FOLLOWERS`

List the teammates following a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation inboxes

**Slug:** `FRONT_LIST_CONVERSATION_INBOXES`

List the inboxes in which a conversation is listed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation messages

**Slug:** `FRONT_LIST_CONVERSATION_MESSAGES`

List the messages in a conversation in reverse chronological order (newest first).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `sort_by` | string | No | Field used to sort the messages. Only supports `created_at`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversations

**Slug:** `FRONT_LIST_CONVERSATIONS`

List the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company's [bump settings](https://help.front.com/t/y729th/customize-when-conversations-bump-up), which determine when conversations bump to the top. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `trashed`). If ticketing is enabled, this endpoint accepts either `status_categories` (`open`, `waiting`, `resolved`) or `status_ids` as an alternative. |
| `sort_by` | string | No | Field used to sort the conversations. Only supports `date`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Custom Fields

**Slug:** `FRONT_LIST_CUSTOM_FIELDS`

List custom-field definitions for a selected Front resource type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `resource_type` | string ("account" | "contact" | "conversation" | "inbox" | "link" | "teammate") | Yes | Select which documented Front endpoint context to use. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 events

**Slug:** `FRONT_LIST_EVENTS`

Lists all the detailed events which occurred in the inboxes of the company ordered in reverse chronological order (newest first). Refer to the [Events](https://dev.frontapp.com/reference/events) topic for more information, including sorting and filtering.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per page (max 15) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with optional properties `before`, `after`, `types`, or `inboxes`. `before` and `after` should be a timestamp in seconds with up to 3 decimal places. `types` should be a list of [event types](https://dev.frontapp.com/reference/events). `inboxes` should be a list of inbox IDs. |
| `sort_by` | string | No | Field used to sort the events. Only supports `created_at`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 inbox access

**Slug:** `FRONT_LIST_INBOX_ACCESS`

List the teammates with access to an inbox.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | The Inbox ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 inboxes

**Slug:** `FRONT_LIST_INBOXES`

List the inboxes of the company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Articles

**Slug:** `FRONT_LIST_KNOWLEDGE_BASE_ARTICLES`

List articles in a knowledge base or in one knowledge-base category.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `category_id` | string | No | Required only for `parent_type=category`; forbidden for `parent_type=knowledge_base`. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `parent_type` | string ("knowledge_base" | "category") | Yes | Article parent. `knowledge_base` requires only `knowledge_base_id` and forbids `category_id`; `category` requires only `category_id` and forbids `knowledge_base_id`. |
| `knowledge_base_id` | string | No | Required only for `parent_type=knowledge_base`; forbidden for `parent_type=category`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 knowledge bases

**Slug:** `FRONT_LIST_KNOWLEDGE_BASES`

List the knowledge bases of the company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 link conversations

**Slug:** `FRONT_LIST_LINK_CONVERSATIONS`

List the conversations linked to a specific link. For more advanced filtering, see the [search endpoint](https://dev.frontapp.com/reference/conversations#search-conversations). For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `trashed`). If ticketing is enabled, this endpoint accepts either `status_categories` (`open`, `waiting`, `resolved`) or `status_ids` as an alternative. |
| `link_id` | string | Yes | The Link ID |
| `sort_by` | string | No | Field used to sort the conversations. Only supports `date`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 linked conversations

**Slug:** `FRONT_LIST_LINKED_CONVERSATIONS`

List the conversations linked to the original conversation in the path. Conversations the requester cannot access are omitted, so a page can hold fewer results than requested while more remain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 links

**Slug:** `FRONT_LIST_LINKS`

List the links of the company paginated by ID. Filter by link type with `filters.types`. These links include application objects; for more details, see the [Links](https://dev.frontapp.com/reference/links) topic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `types`, whose value should be a list of link types. Links created via the API have type `web` and links created by application objects have type `app_<uid>`, matching the app UID where the object is configured. There are also types `jira`, `asana`, `monday`, `trello`, and `github`, which correspond to the integrations built by Front. |
| `sort_by` | string | No | Field used to sort the links. Only supports `id`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Message Template Folders

**Slug:** `FRONT_LIST_MESSAGE_TEMPLATE_FOLDERS`

List message-template folders globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at") | No | Field used to sort the message template folders. Either `created_at` or `updated_at`. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Folder owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Message Templates

**Slug:** `FRONT_LIST_MESSAGE_TEMPLATES`

List message templates globally or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort_by` | string ("created_at" | "updated_at" | "sort_order") | No | Field used to sort the message templates. Either `created_at`, `updated_at`, or `sort_order`. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Template owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Related Conversations

**Slug:** `FRONT_LIST_RELATED_CONVERSATIONS`

List conversations related to one tag, contact, inbox, or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `tag_id` | string | No | Required only for `related_resource_type=tag`; forbidden for all other resource types. |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with a property `statuses`, whose value should be a list of conversation statuses (`assigned`, `unassigned`, `archived`, or `trashed`). If ticketing is enabled, this endpoint accepts either `status_categories` (`open`, `waiting`, `resolved`) or `status_ids` as an alternative. |
| `inbox_id` | string | No | Required only for `related_resource_type=inbox`; forbidden for all other resource types. |
| `contact_id` | string | No | Required only for `related_resource_type=contact`; forbidden for all other resource types. A contact source-and-handle resource alias is accepted. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required only for `related_resource_type=teammate`; forbidden for all other resource types. A teammate email resource alias is accepted. |
| `related_resource_type` | string ("tag" | "contact" | "inbox" | "teammate") | Yes | Related resource. Each value requires only its matching ID (`tag_id`, `contact_id`, `inbox_id`, or `teammate_id`) and forbids the other three IDs. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Rules

**Slug:** `FRONT_LIST_RULES`

List rules globally, company-wide, or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global`, `company`, and `teammate`. |
| `owner_type` | string ("global" | "company" | "team" | "teammate") | Yes | Rule owner. `global` and `company` forbid both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global`, `company`, and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Shifts

**Slug:** `FRONT_LIST_SHIFTS`

List shifts globally or for one team or teammate; requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global` and `teammate`. |
| `owner_type` | string ("global" | "team" | "teammate") | Yes | Shift owner. `global` forbids both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global` and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 shift's teammates

**Slug:** `FRONT_LIST_SHIFTS_TEAMMATES`

List the teammates assigned to a shift. Requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shift_id` | string | Yes | The Shift ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Signatures

**Slug:** `FRONT_LIST_SIGNATURES`

List signatures owned by one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | No | Required for `owner_type=team`; forbidden for `owner_type=teammate`. |
| `owner_type` | string ("team" | "teammate") | Yes | Signature owner. `team` requires only `team_id` and forbids `teammate_id`; `teammate` requires only `teammate_id` and forbids `team_id`. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required for `owner_type=teammate`; forbidden for `owner_type=team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 tag children

**Slug:** `FRONT_LIST_TAG_CHILDREN`

List the direct child tags beneath a specified parent tag.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_id` | string | Yes | The tag ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Tags

**Slug:** `FRONT_LIST_TAGS`

List tags globally, company-wide, or for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `sort_by` | string | No | Field used to sort the tags. Only supports `id`. |
| `team_id` | string | No | Required only for `owner_type=team`; forbidden for `global`, `company`, and `teammate`. |
| `owner_type` | string ("global" | "company" | "team" | "teammate") | Yes | Tag owner. `global` and `company` forbid both owner IDs; `team` requires only `team_id`; `teammate` requires only `teammate_id`. |
| `sort_order` | string ("asc" | "desc") | No | Order by which results should be sorted |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required only for `owner_type=teammate`; forbidden for `global`, `company`, and `team`. A teammate email resource alias is accepted. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 team inboxes

**Slug:** `FRONT_LIST_TEAM_INBOXES`

List the inboxes belonging to a team (workspace).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The team ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate private inboxes

**Slug:** `FRONT_LIST_TEAMMATE_PRIVATE_INBOXES`

List private inboxes owned by a specified teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_id` | string | Yes | The teammate ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammates

**Slug:** `FRONT_LIST_TEAMMATES`

List all company teammates for teammate discovery and ID resolution.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teams

**Slug:** `FRONT_LIST_TEAMS`

List the teams (workspaces) in the company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Time Offs

**Slug:** `FRONT_LIST_TIME_OFFS`

List time-off records for one team or teammate.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `filters` | object | No | [Search query object](https://dev.frontapp.com/docs/query-object-q) with the optional properties `active_from` and `active_until`, whose value should be a timestamp in seconds with up to 3 decimal places. |
| `team_id` | string | No | Required for `owner_type=team`; forbidden for `owner_type=teammate`. |
| `owner_type` | string ("team" | "teammate") | Yes | Time-off owner. `team` requires only `team_id` and forbids `teammate_id`; `teammate` requires only `teammate_id` and forbids `team_id`. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |
| `teammate_id` | string | No | Required for `owner_type=teammate`; forbidden for `owner_type=team`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Views

**Slug:** `FRONT_LIST_VIEWS`

List views globally or for one team.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `team_id` | string | No | Required for `owner_type=team`; forbidden for `owner_type=global`. |
| `owner_type` | string ("global" | "team") | Yes | View owner. `global` forbids `team_id`; `team` requires `team_id`. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message seen

**Slug:** `FRONT_MARK_MESSAGE_SEEN`

Mark an outbound message from Front as seen. Note, the message seen route should only be called in response to an actual end-user's message-seen action. In accordance with this behavior, the route is rate limited to 10 requests per message per hour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | The message ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Merge contacts

**Slug:** `FRONT_MERGE_CONTACTS`

Merges the contacts specified into a single contact, deleting the merged-in contacts. If a target contact ID is supplied, the other contacts will be merged into that one. Otherwise, some contact in the contact ID list will be treated as the target contact. Merge conflicts will be resolved in the following ways: * name will prioritize manually-updated and non-private contact names * descriptions will be concatenated and separated by newlines in order from oldest to newest with the (optional) target contact's description first * all handles, groups, links, and notes will be preserved * other conflicts will use the most recently updated contact's value This irreversibly merges contact records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_ids` | array | Yes | Array of all the contact IDs of the contacts to be merged.  If a target contact id is provided and that contact id is not in this array, the length of this array must be between 1 and 49.  If no target contact id is provided or it is contained in this array, the length must be between 2 and 50. |
| `target_contact_id` | string | No | Optional contact ID to merge the other contacts into. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Receive custom messages

**Slug:** `FRONT_RECEIVE_CUSTOM_MESSAGES`

Receive a custom message in Front. This endpoint is available for custom channels **ONLY**.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Body of the message |
| `sender` | object | Yes | Sender details: required `handle`, plus optional `name` and Front `contact_id`. |
| `subject` | string | No | Subject of the message |
| `metadata` | object | No | Optional metadata: `thread_ref` controls custom-channel threading, and `headers` stores arbitrary key-value information with the message. |
| `channel_id` | string | Yes | The channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `body_format` | string ("html" | "markdown") | No | Format of the message body. Can be `markdown` (default) or `html`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Refresh application objects

**Slug:** `FRONT_REFRESH_APPLICATION_OBJECTS`

Refresh or update existing application objects that match an exact pattern. This does not create new application objects.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Optional link name. An installed links integration may override it. |
| `pattern` | string | Yes | Exact string matched by configured application objects to refresh their latest information from external systems. For example, use `ORDER-777` for an application object configured to match `ORDER-{Digits}`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group team inboxes

**Slug:** `FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAM_INBOXES`

Unlinks non-public inboxes from the teammate group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_ids` | array | Yes | IDs of the non-public inboxes to unlink from the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group teammates

**Slug:** `FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAMMATES`

Remove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_ids` | array | Yes | IDs of the teammates to remove from the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate group teams

**Slug:** `FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAMS`

Remove teams from the teammate group. Unlinks to any associated team inboxes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_ids` | array | Yes | IDs of the teams to remove from the teammate group. |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contact from Account

**Slug:** `FRONT_REMOVE_CONTACT_FROM_ACCOUNT`

Removes a list of contacts from an Account

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `contact_ids` | array | Yes | The contact IDs to include. Alternatively, you can supply the contact source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 contacts from contact list

**Slug:** `FRONT_REMOVE_CONTACTS_FROM_CONTACT_LIST`

Remove specified contact IDs or source-and-handle resource aliases from a contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_ids` | array | Yes | List of IDs of the contacts to remove from the requested contact list. Alternatively, you can supply the contact source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `contact_list_id` | string | Yes | The contact list ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation followers

**Slug:** `FRONT_REMOVE_CONVERSATION_FOLLOWERS`

Removes teammates from the list of followers of a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teammate_ids` | array | Yes | IDs of the teammate to remove from the followers list. Alternatively, you can supply the teammates as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation links

**Slug:** `FRONT_REMOVE_CONVERSATION_LINKS`

Removes one or more links to a conversation. For more information on links, see the [Links](https://dev.frontapp.com/reference/links) topic.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `link_ids` | array | Yes | Link IDs to remove. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation tag

**Slug:** `FRONT_REMOVE_CONVERSATION_TAG`

Removes one or more tags to a conversation

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag_ids` | array | Yes | IDs of the tags to remove from the conversation. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Removes inbox access

**Slug:** `FRONT_REMOVE_INBOX_ACCESS`

Remove access of one or more teammates from an inbox.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `inbox_id` | string | Yes | The Inbox ID |
| `teammate_ids` | array | Yes | IDs of the teammates whose access to the inbox should be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammates from shift

**Slug:** `FRONT_REMOVE_TEAMMATES_FROM_SHIFT`

Remove teammates from a shift. Requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shift_id` | string | Yes | The Shift ID |
| `teammate_ids` | array | Yes | IDs of the teammates to remove from the shift. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammates from team

**Slug:** `FRONT_REMOVE_TEAMMATES_FROM_TEAM`

Remove one or more teammates from a team (workspace).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `team_id` | string | Yes | The Team ID |
| `teammate_ids` | array | Yes | IDs of the teammates to remove from the team. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message reply

**Slug:** `FRONT_REPLY_TO_CONVERSATION`

Reply to a conversation by sending and appending an external message. The conversation can optionally be tagged and archived immediately after sending. Sending cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of the recipient handles who will receive a copy of this message |
| `to` | array | No | List of the recipient handles who will receive this message |
| `bcc` | array | No | List of the recipient handles who will receive a copy of this message |
| `body` | string | Yes | Body of the message |
| `text` | string | No | Text version of the body for email messages |
| `options` | object | No | Optional reply behavior: `tag_ids` adds tags to the conversation and `archive` archives it immediately after sending. |
| `subject` | string | No | Subject of the message for email message |
| `author_id` | string | No | ID of the teammate on behalf of whom the answer is sent |
| `channel_id` | string | No | Channel ID the message is sent from |
| `quote_body` | string | No | Body for the quote that the message is referencing. Only available on email channels. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `sender_name` | string | No | Name used for the sender info of the message |
| `signature_id` | string | No | ID of the signature to attach to this draft. Only supported for email channels; using this on other channel types returns a 403 forbidden error. If null, no signature is attached. |
| `conversation_id` | string | Yes | The conversation ID |
| `should_add_default_signature` | boolean | No | Whether or not Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is included or if author_id is omitted. Default false; |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversations

**Slug:** `FRONT_SEARCH_CONVERSATIONS`

Search for conversations. Response will include a count of total matches and an array of conversations in descending order by last activity. See the [search syntax documentation](https://dev.frontapp.com/docs/search-1) for usage examples. **Note:** This endpoint is subject to [proportional rate limiting](https://dev.frontapp.com/docs/rate-limiting#additional-proportional-limiting) at 40% of your company's rate limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Max number of results per [page](https://dev.frontapp.com/docs/pagination) |
| `query` | string | Yes | Search query string. See [Search](https://dev.frontapp.com/docs/search-1) topic for usage details. |
| `next_cursor` | string | No | Opaque cursor returned by a previous call to this tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message

**Slug:** `FRONT_SEND_MESSAGE`

Send a new external message from a channel and create a conversation. The new conversation can optionally be tagged and archived immediately after sending. Sending cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of the recipient handles who will receive a copy of this message. One of `to`, `cc`, or `bcc` is required. |
| `to` | array | No | List of the recipient handles who will receive this message. One of `to`, `cc`, or `bcc` is required. |
| `bcc` | array | No | List of the recipient handles who will receive a blind copy of this message. One of `to`, `cc`, or `bcc` is required. |
| `body` | string | Yes | Body of the message |
| `text` | string | No | Text version of the body for email messages |
| `options` | object | No | Optional send behavior: `tag_ids` adds tags to the new conversation and `archive` archives it immediately after sending. |
| `subject` | string | No | Subject of the message for email message |
| `author_id` | string | No | ID of the teammate on behalf of whom the answer is sent |
| `channel_id` | string | Yes | The sending channel ID. Alternatively, you can supply the sending channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `sender_name` | string | No | Name used for the sender info of the message |
| `signature_id` | string | No | ID of the signature to attach to this draft. Only supported for email channels; using this on other channel types returns a 403 forbidden error. If null, no signature is attached. |
| `should_add_default_signature` | boolean | No | Whether or not Front should try to resolve a signature for the message. Only applies to email channels and is ignored if signature_id is included or if author_id is omitted. Default false. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Trigger application event

**Slug:** `FRONT_TRIGGER_APPLICATION_EVENT`

Trigger Front workflows for an application object. This endpoint requires a company API token with the Application Triggers permission and cannot be used with Front app OAuth tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `dry_run` | boolean | No | Set true while configuring a trigger to send a test event. An `app_object.id` or `app_object.ext_link` is still required but need not identify a real object. |
| `app_object` | object | Yes | Application object associated with the trigger. Provide at least one identifier: `id` or `ext_link`; if both are supplied, Front favors `id`. |
| `event_type` | string | Yes | Event type configured in the application's trigger settings. |
| `properties` | object | No | Additional event properties exposed to the triggered Front workflow as dynamic variables. |
| `application_uid` | string | Yes | The application UID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 account

**Slug:** `FRONT_UPDATE_ACCOUNT`

Update an account's name, description, domains, or custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the Account |
| `domains` | array | No | List of domains associated with the Account |
| `account_id` | string | Yes | The Account ID. Alternatively, you can supply the account domain or external ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `description` | string | No | Account description |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Channel

**Slug:** `FRONT_UPDATE_CHANNEL`

Update a channel's name or settings, or move it to another inbox together with its conversations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the channel |
| `inbox_id` | string | No | ID of the inbox to move this channel to. Will also move corresponding conversations. |
| `settings` | object | No | Settings to replace. For custom channels, all settings may be replaced. For all other channels, only `undo_send_time` and `all_teammates_can_reply` may be replaced.  |
| `channel_id` | string | Yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 comment

**Slug:** `FRONT_UPDATE_COMMENT`

Update a comment in a [conversation](https://dev.frontapp.com/reference/conversations).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Content of the comment. Can include markdown formatting. Can only be updated if the comment was created using the same token. |
| `is_pinned` | boolean | No | Whether or not the comment is pinned in its conversation. |
| `comment_id` | string | Yes | The Comment ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a teammate group

**Slug:** `FRONT_UPDATE_COMPANY_TEAMMATE_GROUP`

Updates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the teammate group |
| `description` | string | No | Description of the teammate group |
| `permissions` | object | No | Permissions for the teammate group |
| `teammate_group_id` | string | Yes | The teammate group ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a contact

**Slug:** `FRONT_UPDATE_CONTACT`

Update a contact's profile, links, list memberships, and custom fields; missing named groups may be created.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Contact name |
| `links` | array | No | List of all the links of the contact |
| `avatar` | object | No | Replacement avatar image upload, up to 25 MB. |
| `contact_id` | string | Yes | The contact ID. Alternatively, you can supply the contact's source and handle as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `list_names` | array | No | List of all the contact list names the contact belongs to. It will automatically create missing groups |
| `description` | string | No | Contact description |
| `group_names` | array | No | List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use `list_names` instead. |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation

**Slug:** `FRONT_UPDATE_CONVERSATION`

Update a conversation's assignee, inbox, status, tags, task details, due date, or custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `due_at` | number | No | Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed on task conversations. Set to null to clear. |
| `status` | string ("archived" | "open" | "deleted" | "spam") | No | New status of the conversation |
| `tag_ids` | array | No | List of all the tag IDs replacing the old conversation tags |
| `inbox_id` | string | No | ID of the inbox to move the conversation to. |
| `status_id` | string | No | Unique identifier of the status to set the conversation to. Only one of status and status_id should be provided. Ticketing must be enabled for the company to use this field. |
| `assignee_id` | string | No | ID of the teammate to assign the conversation to. Set it to null to unassign. |
| `description` | string | No | Description of the task. Only allowed on task conversations. Set to null to clear. |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation assignee

**Slug:** `FRONT_UPDATE_CONVERSATION_ASSIGNEE`

Assign or unassign a conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `assignee_id` | string | Yes | ID of the teammate to assign the conversation to. Set it to null to unassign. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 conversation reminders

**Slug:** `FRONT_UPDATE_CONVERSATION_REMINDERS`

Snooze or unsnooze a conversation for the provided user. For private conversations, reminders can only be created and edited through the API for teammates that own the conversation. For shared conversations, reminders created and edited through the API are shared for all teammates within the shared inbox(es) that the conversation belongs to.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cancel` | boolean | No | Set true to cancel the reminder by sending `scheduled_at: null`. Cannot be combined with a timestamp. |
| `status_id` | string | No | ID of the waiting status to which the conversation will be set. Ticketing must be enabled for the company to use this field. If no status is supplied and ticket is enabled, the default waiting status will be used. |
| `teammate_id` | string | Yes | ID of the teammate to create a reminder for. For a private conversation, specify the id of the teammate that owns the conversation. For a shared conversation, use the id of any teammate that has access to the conversation's shared inbox. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `scheduled_at` | number | No | Unix timestamp in seconds to schedule the reminder for. Must be in the future and within 50 years. To cancel, omit this field and set `cancel` to true. |
| `conversation_id` | string | Yes | The conversation ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Edit draft

**Slug:** `FRONT_UPDATE_DRAFT`

Update an existing shared draft's body, recipients, channel, attachments, signature, subject, and version.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cc` | array | No | List of recipient handles who will receive a copy of the message once the draft is sent |
| `to` | array | No | List of recipient handles who will receive the message once the draft is sent |
| `bcc` | array | No | List of the recipient handles who will receive a blind copy of the message once the draft is sent |
| `body` | string | Yes | Body of the draft |
| `mode` | string | No | Mode of the draft to update. Can only be 'shared' (draft is visible to all teammates with access to the conversation). |
| `subject` | string | No | Subject of the draft. |
| `version` | string | No | Version of the draft |
| `author_id` | string | No | ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). If omitted, will post as the API Token or Application making the request. |
| `channel_id` | string | Yes | ID of the channel from which the draft will be sent. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `message_id` | string | Yes | The draft ID |
| `quote_body` | string | No | Body for the quote that the message is referencing. Only available on email channels. |
| `attachments` | array | No | Files to attach, up to 25 MB each. |
| `signature_id` | string | No | ID of the signature to attach to this draft. If null, no signature is attached. |
| `should_add_default_signature` | boolean | No | Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false; |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Article Content

**Slug:** `FRONT_UPDATE_KNOWLEDGE_BASE_ARTICLE_CONTENT`

Update article content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| `status` | string ("draft" | "published") | No | Article status |
| `content` | string | Yes | HTML content of the article |
| `subject` | string | No | Subject of the article |
| `author_id` | string | Yes | Teammate ID of the article author |
| `article_id` | string | Yes | The ID of the article to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Category Content

**Slug:** `FRONT_UPDATE_KNOWLEDGE_BASE_CATEGORY_CONTENT`

Update category content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the knowledge base category |
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| `category_id` | string | Yes | The ID of the category to update |
| `description` | string | No | Description of the knowledge base category |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 Knowledge Base Content

**Slug:** `FRONT_UPDATE_KNOWLEDGE_BASE_CONTENT`

Update knowledge-base content in its default locale or a specified locale.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the knowledge base |
| `locale` | string | No | The [locale](https://dev.frontapp.com/reference/knowledge-bases#locales) of the updated content |
| `knowledge_base_id` | string | Yes | The ID of the knowledge base to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a link

**Slug:** `FRONT_UPDATE_LINK`

Rename an existing Front link.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the link |
| `link_id` | string | Yes | The Link ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 message template

**Slug:** `FRONT_UPDATE_MESSAGE_TEMPLATE`

Update a message template's name, subject, body, parent folder, inbox availability, or attachments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | New body of the message template. HTML with inline CSS is supported. |
| `name` | string | No | New name of the message template. |
| `subject` | string | No | New subject of the message template. |
| `folder_id` | string | No | ID of the parent message template folder. |
| `inbox_ids` | array | No | Non-empty list of inbox IDs where the template is available; omit to leave availability unchanged. |
| `attachments` | array | No | Replacement attachments, up to 25 MB each. Pass an empty list to delete all attachments; omit to retain existing attachments. |
| `message_template_id` | string | Yes | The message template ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 folder

**Slug:** `FRONT_UPDATE_MESSAGE_TEMPLATE_FOLDER`

Update message template folder

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the message template folder |
| `parent_folder_id` | string | No | ID of the parent folder to be placed into. Goes into the root folder if unspecified or if null. |
| `message_template_folder_id` | string | Yes | The message template folder ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 shift

**Slug:** `FRONT_UPDATE_SHIFT`

Update a shift. Requires a Front plan with Shifts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the shift |
| `color` | string ("black" | "grey" | "pink" | "purple" | "blue" | "teal" | "green" | "yellow" | "orange" | "red") | No | Color of the shift |
| `times` | object | No | Replacement shift intervals by weekday. Each included day requires `start` and `end` strings interpreted in the shift's IANA timezone. |
| `shift_id` | string | Yes | The Shift ID |
| `timezone` | string | No | A timezone name as defined in the IANA tz database |
| `teammate_ids` | array | No | List of all the teammate ids who will be part of this shift. Alternatively, you can supply emails as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 signature

**Slug:** `FRONT_UPDATE_SIGNATURE`

Update a signature's name, sender information, body, visibility, default status, or channel availability.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Body of the signature |
| `name` | string | No | Name of the signature |
| `is_default` | boolean | No | If true, the signature will be set as the default signature for the team or teammate. |
| `channel_ids` | array | No | The specific shared channels this signature if available in. If null, then it will be available in all channels. If unspecified, will retain previous value. Alternatively, you can specify channels using a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `sender_info` | string | No | Sender info of the signature that will appear in the From line of emails sent. |
| `signature_id` | string | Yes | The signature ID |
| `is_visible_for_all_teammate_channels` | boolean | No | Whether or not the signature is visible in all individual channels for teammates in the given team. Can only be set for shared signatures. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 a tag

**Slug:** `FRONT_UPDATE_TAG`

Update a tag's name, description, color, parent, or conversation-list visibility.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the tag |
| `tag_id` | string | Yes | The tag ID |
| `highlight` | string ("grey" | "pink" | "red" | "orange" | "yellow" | "green" | "light-blue" | "blue" | "purple") | No | Highlight color of the tag. |
| `description` | string | No | Description of the tag |
| `parent_tag_id` | string | No | ID of the parent of this tag. Set to `null` to remove  the parent tag. |
| `is_visible_in_conversation_lists` | boolean | No | Whether the tag is visible in conversation lists. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 teammate

**Slug:** `FRONT_UPDATE_TEAMMATE`

Update a teammate's username, name, availability, or custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `username` | string | No | New username. It must be unique and can only contains lowercase letters, numbers and underscores. |
| `last_name` | string | No | New last name |
| `first_name` | string | No | New first name |
| `teammate_id` | string | Yes | The teammate ID. Alternatively, you can supply an email as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |
| `is_available` | boolean | No | New availability status |
| `custom_fields` | object | No | An object whose key is the `name` property defined for the custom field in the Front UI. The value of the key must use the same `type` specified for the custom field, as described in https://dev.frontapp.com/reference/custom-fields |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 time off

**Slug:** `FRONT_UPDATE_TIME_OFF`

Update a time-off record's name, dates, or auto-responder settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the time off |
| `end_at` | number | No | Timestamp when the time off ends (in seconds), or null to clear it |
| `start_at` | number | No | Timestamp when the time off starts (in seconds) |
| `time_off_id` | string | Yes | The time off ID |
| `auto_responder` | object | No | Auto-responder fields to update: message `body`, `is_enabled`, `is_contacts_only`, and applicable `channel_ids`. Omit this object to leave auto-responder settings unchanged. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 view

**Slug:** `FRONT_UPDATE_VIEW`

Update a conversation view's name, inbox filters, tag filters, assignee filters, exclusions, no-tag setting, or highlight color.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the view |
| `no_tags` | boolean | No | Whether to filter for conversations without tags |
| `tag_ids` | array | No | List of tag IDs to filter by |
| `view_id` | string | Yes | The view ID |
| `highlight` | string | No | Color highlight for the view |
| `inbox_ids` | array | No | List of inbox IDs to filter by |
| `not_tag_ids` | array | No | List of tag IDs to exclude |
| `assignee_ids` | array | No | List of assignee IDs to filter by |
| `not_assignee_ids` | array | No | List of assignee IDs to exclude |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |

### Validate channel

**Slug:** `FRONT_VALIDATE_CHANNEL`

Asynchronously validate an SMTP channel (this endpoint is irrelevant to other channel types). When you create an SMTP channel via the API, [create a channel](https://dev.frontapp.com/reference/post_inboxes-inbox-id-channels) with type smtp and the send_as set to the needed email address. You then [configure the email provider](https://help.front.com/en/articles/2081), after which you use this endpoint to asynchronously validate the SMTP settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | string | Yes | The Channel ID. Alternatively, you can supply the channel address as a [resource alias](https://dev.frontapp.com/docs/resource-aliases-1). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | 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 |