Skip to main content
Front logo
  • Category: customer support
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 180
  • Triggers: 0
  • Slug: FRONT
  • Version: 20261101_00

Tools

Slug: FRONT_ADD_COMMENTAdd a comment to a conversation or reply to an existing comment.

Input Parameters

string
required
Content of the comment. Can include markdown formatting.
string
ID of the teammate creating the comment. Alternatively, you can supply the author as a resource alias. If omitted, will post as the API Token or OAuth client of the requester.
boolean
Whether or not the comment is pinned in its conversation.
string
Required only when target_type is comment; forbidden when it is conversation.
array
Files to attach, up to 25 MB each.
string ("conversation" | "comment")
required
Comment target. conversation requires only conversation_id and forbids comment_id; comment requires only comment_id and forbids conversation_id.
string
Required only when target_type is conversation; forbidden when it is comment.

Output

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

array
required
IDs of the non-public team inboxes to link to the teammate group.
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_COMPANY_TEAMMATE_GROUP_TEAMMATESAdd teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.

Input Parameters

array
required
IDs of the teammates to add to the teammate group.
string
required
The teammate group ID.

Output

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

array
required
IDs of the teams to add to the teammate group.
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_CONTACT_HANDLEAdd an email, phone, Twitter, Facebook, Intercom, Front Chat, or custom handle to an existing contact.

Input Parameters

string
required
Handle used to reach the contact.
string ("twitter" | "email" | "phone" | "facebook" | "intercom" | "front_chat" | "custom")
required
Source of the handle. Can be email, phone, twitter, facebook, intercom, front_chat, or custom.
string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_CONTACTS_TO_CONTACT_LISTAdd multiple existing contacts, identified by contact ID or source-and-handle resource alias, to a contact list.

Input Parameters

array
required
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.
string
required
The contact list ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_CONTACT_TO_ACCOUNTAdds a list of contacts to an Account

Input Parameters

string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
array
required
The contact IDs to include. Alternatively, you can supply the contact source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_CONVERSATION_FOLLOWERSAdd one or more teammates as followers of an existing conversation, optionally ignoring invalid teammate IDs.

Input Parameters

array
required
IDs of the teammate to add to the followers list. Alternatively, you can supply the teammates as a resource alias.
boolean
Whether to ignore invalid teammate IDs and continue adding valid ones.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_CONVERSATION_TAGAttach one or more existing tags, identified by tag ID, to a conversation.

Input Parameters

array
required
IDs of the tags to add to the conversation.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_INBOX_ACCESSGrant specified teammates access to an existing inbox.

Input Parameters

string
required
The Inbox ID
array
required
IDs of the teammates to grant access to the inbox.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_NOTECreate a new note on a contact.

Input Parameters

string
required
Content of the note
string
required
ID of teammate creating the note
string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_TEAMMATES_TO_SHIFTAdd teammates to a shift. The selected teammates must be in the team that owns the shift. Requires a Front plan with Shifts.

Input Parameters

string
required
The Shift ID
array
required
IDs of the teammates to add to the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_TEAMMATES_TO_TEAMAdd one or more teammates to a team (workspace).

Input Parameters

string
required
The Team ID
array
required
IDs of the teammates to add to the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_ADD_VIEW_TEAMMATESMakes this view visible in specified teammates’ sidebar navigation.

Input Parameters

string
required
The view ID
array
required
IDs of teammates whose sidebar should display the view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_ACCOUNTCreate a Front account with optional domains, external ID, description, and custom fields.

Input Parameters

string
required
Name of the Account
array
List of domains associated with the Account
string
Account description
string
ID of the Account in an external system
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_ANALYTICS_EXPORTCreate 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 topic for details about specific metrics.

Input Parameters

number
required
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.
string ("messages" | "events")
required
The type of export to create. The type you specify determines which columns are available for the export.
number
required
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.
array
required
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.
object
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.
string
IANA name of the timezone to format the dates with. If omitted, the export will use Etc/UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_ANALYTICS_REPORTCreate 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 topic for details about specific metrics.

Input Parameters

number
required
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.
number
required
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.
object
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.
array
required
List of the metrics required.
string
IANA name of the timezone to format the dates with. If omitted, the export will use Etc/UTC.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CHANNELCreate a custom, SMTP, Twilio, or developer-application channel in an existing inbox.

Input Parameters

string
Name of the channel
string ("custom" | "smtp" | "twilio")
required
Type of the channel
string
Sending address of your channel. Required for SMTP and Twilio channels.
string
required
The Inbox ID
object
Settings of the channel
object
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.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CHILD_MESSAGE_TEMPLATECreate a new message template as a child of the given folder

Input Parameters

string
required
Body of the message template. You can supply HTML with inline CSS to structure and style your template.
string
required
Name of the message template
string
Subject of the message template.
array
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.
string
required
The parent message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CHILD_MESSAGE_TEMPLATE_FOLDERCreate a new message template folder as a child of the given folder

Input Parameters

string
required
Name of the message template folder
string
required
The parent message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_COMPANY_TEAMMATE_GROUPCreate a company teammate group with an optional description and contact-list permissions.

Input Parameters

string
required
Name of the teammate group
string
Description of the teammate group
object
Permissions for the teammate group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CONTACTCreate a contact globally or for one team or teammate. Supplying named groups or contact lists also creates any that are missing.

Input Parameters

string
Contact name
List of all the links of the contact
object
Avatar image upload, up to 25 MB.
array
required
List of the handles for this contact. Each handle object should include handle and source fields.
string
Required only for owner_type=team; forbidden for global and teammate.
array
List of all the contact list names the contact belongs to. It will automatically create missing groups
string ("global" | "team" | "teammate")
required
Contact owner. global forbids both owner IDs; team requires only team_id; teammate requires only teammate_id.
string
Contact description
array
List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use list_names instead.
string
Required only for owner_type=teammate; forbidden for global and team. A teammate email resource alias is accepted.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CONTACT_LISTCreate a contact list globally or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_CONVERSATIONCreate 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 endpoint. If you want to add a comment to an existing conversation, use the Add comment endpoint.

Input Parameters

string ("discussion" | "task")
required
Conversation type
number
Unix timestamp in seconds when the task is due. Must be in the future and within 50 years. Only allowed when type is task.
object
Details for the starter comment. Required for discussions, optional for tasks.
string
required
Subject of the conversation. Used as the title for tasks.
string
Inbox ID for the conversation. Either inbox_id OR teammate_ids must be provided (not both).
string
Description of the task. Only allowed when type is task.
array
Teammates to add to the conversation. Either inbox_id OR teammate_ids must be provided (not both).
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_DRAFTCreate a draft message which is the first message of a new conversation.

Input Parameters

array
List of recipient handles who will receive a copy of the message once the draft is sent
array
List of recipient handles who will receive the message once the draft is sent
array
List of the recipient handles who will receive a blind copy of the message once the draft is sent
string
required
Body of the draft
string ("private" | "shared")
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).
string
Subject of the draft.
string
ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a resource alias. If omitted, will post as the API Token or Application making the request.
string
required
The channel ID. Alternatively, you can supply the channel address as a resource alias.
string
Body for the quote that the message is referencing. Only available on email channels.
array
Files to attach, up to 25 MB each.
string
ID of the signature to attach to this draft. If null, no signature is attached.
boolean
Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false;

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_DRAFT_REPLYCreate a new draft as a reply to the last message in the conversation.

Input Parameters

array
List of recipient handles who will receive a copy of the message once the draft is sent
array
List of recipient handles who will receive the message once the draft is sent
array
List of the recipient handles who will receive a blind copy of the message once the draft is sent
string
required
Body of the draft
string ("private" | "shared")
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).
string
Subject of the draft.
string
ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a resource alias. If omitted, will post as the API Token or Application making the request.
string
required
ID of the channel from which the draft will be sent. Alternatively, you can supply the channel address as a resource alias.
string
Body for the quote that the message is referencing. Only available on email channels.
array
Files to attach, up to 25 MB each.
string
ID of the signature to attach to this draft. If null, no signature is attached.
string
required
The conversation ID
boolean
Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false;

Output

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

Input Parameters

string
required
The name of the inbox
boolean
Whether the inbox is public or not
array
An array of teammate IDs that should have access to the inbox. Alternatively, you can supply teammate emails as a resource alias.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_KNOWLEDGE_BASECreate an internal company-only or externally available knowledge base.

Input Parameters

string
required
Name of the knowledge base
string ("internal" | "external")
Determines if the knowledge base is publicly available or private only to your company

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_KNOWLEDGE_BASE_ARTICLECreate an article in a knowledge base’s default locale or a specified locale.

Input Parameters

string
The locale of the article’s content
string ("draft" | "published")
Article status
string
required
HTML content of the article
string
required
Subject of the article
string
required
Teammate ID of the article author
string
ID of the category this article belongs to
string
required
The ID of the knowledge base to create the article in

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_KNOWLEDGE_BASE_CATEGORYCreate a category in a knowledge base’s default locale or a specified locale.

Input Parameters

string
required
Name of the knowledge base category
string
The locale of the category’s content
string
Description of the knowledge base category
string
required
The ID of the knowledge base to create the category in
string
ID of the parent category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_MESSAGE_TEMPLATECreate a message template globally or for one team.

Input Parameters

string
required
Body of the message template. You can supply HTML with inline CSS to structure and style your template.
string
required
Name of the message template
string
Subject of the message template.
string
Required for owner_type=team; forbidden for owner_type=global.
string
ID of the message template folder to place this message template in
array
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.
string ("global" | "team")
required
Template owner. global forbids team_id; team requires team_id.
array
Files to attach, up to 25 MB each.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_MESSAGE_TEMPLATE_FOLDERCreate a message-template folder globally or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_SHIFTCreate a global or team-owned shift; requires a Front plan with Shifts.

Input Parameters

string
required
Name of the shift
string ("black" | "grey" | "pink" | "purple" | "blue" | "teal" | "green" | "yellow" | "orange" | "red")
required
Color of the shift
object
required
Shift intervals by weekday. Each included day requires start and end strings interpreted in timezone.
string
Required for owner_type=team; forbidden for owner_type=global.
string
required
A timezone name as defined in the IANA tz database
string ("global" | "team")
required
Shift owner. global forbids team_id; team requires team_id.
array
required
List of all the teammate ids who will be part of this shift. Alternatively, you can supply emails as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TAGCreate a tag globally, company-wide, under a parent tag, or for one team or teammate.

Input Parameters

string
required
Name of the tag
string
Required only for owner_type=parent_tag; forbidden for every other owner type.
string
Required only for owner_type=team; forbidden for every other owner type.
string ("grey" | "pink" | "red" | "orange" | "yellow" | "green" | "light-blue" | "blue" | "purple")
Highlight color of the tag.
string ("global" | "company" | "parent_tag" | "team" | "teammate")
required
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.
string
Description of the tag
string
Required only for owner_type=teammate; forbidden for every other owner type. A teammate email resource alias is accepted.
boolean
Whether the tag is visible in conversation lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAM_INBOXCreate a team inbox and optionally configure teammate access, public visibility, and custom fields.

Input Parameters

string
required
The name of the inbox
string
required
The team ID
boolean
Whether the inbox is public or not
array
An array of teammate IDs that should have access to the inbox. Alternatively, you can supply teammate emails as a resource alias.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAMMATE_MESSAGE_TEMPLATECreate a teammate-owned message template, optionally inside a message-template folder.

Input Parameters

string
required
Body of the message template. You can supply HTML with inline CSS to structure and style your template.
string
required
Name of the message template
string
Subject of the message template.
string
ID of the message template folder to place this message template in
string
required
The teammate ID. Alternatively, you can supply an email as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAMMATE_PRIVATE_INBOXCreate a private inbox owned by a specified teammate, with optional custom fields.

Input Parameters

string
required
The name of the inbox
string
required
The teammate ID
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAMMATE_SIGNATURECreate a teammate email signature and optionally make it the default or limit it to selected channels.

Input Parameters

string
required
Body of the signature
string
required
Name of the signature
boolean
If true, the signature will be set as the default signature for the teammate.
array
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.
string
Sender info of the signature that will appear in the From line of emails sent.
string
required
The teammate ID. Alternatively, you can supply an email as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAM_SIGNATURECreate a team email signature and optionally configure default status and channel visibility.

Input Parameters

string
required
Body of the signature
string
required
Name of the signature
string
required
The team ID
boolean
If true, the signature will be set as the default signature for the team.
array
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.
string
Sender info of the signature that will appear in the From line of emails sent.
boolean
Whether or not the signature is visible in all individual channels for teammates in the given team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TEAM_VIEWCreate a team conversation view filtered by inboxes, tags, assignees, and optional exclusions.

Input Parameters

string
required
Name of the view
boolean
Whether to filter for conversations without tags
array
List of tag IDs to filter by
string
required
The team ID
string
Color highlight for the view
array
required
List of inbox IDs to filter by
array
List of tag IDs to exclude
array
List of assignee IDs to filter by
array
List of assignee IDs to exclude

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_CREATE_TIME_OFFCreate a time off for a teammate.

Input Parameters

string
required
Name of the time off
number
Timestamp when the time off ends (in seconds), or null if open-ended
number
required
Timestamp when the time off starts (in seconds)
string
required
The teammate ID. Alternatively, you can supply an email as a resource alias.
object
Optional auto-responder settings: message body, is_enabled, is_contacts_only, and applicable channel_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_ACCOUNTDeletes an account This permanently deletes the resource.

Input Parameters

string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_COMPANY_TEAMMATE_GROUPDeletes a teammate group. Note - You cannot delete a teammate group that is managed by SCIM. This permanently deletes the resource.

Input Parameters

string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_CONTACTDelete a contact. This permanently deletes the resource.

Input Parameters

string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

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

boolean
If true and this is the contact’s last handle, permanently delete the entire contact.
string
required
Handle used to reach the contact.
string ("twitter" | "email" | "phone" | "facebook" | "intercom" | "front_chat" | "custom")
required
Source of the handle. Can be email, phone, twitter, facebook, intercom, front_chat, or custom.
string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_CONTACT_LISTDelete a contact lists. This permanently deletes the resource.

Input Parameters

string
required
The contact list ID

Output

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

string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_DRAFTDelete a draft message. This permanently deletes the resource.

Input Parameters

string
required
Version of the draft
string
required
The draft ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_KNOWLEDGE_BASE_ARTICLEDeletes an article and all its content and translations. This permanently deletes the resource.

Input Parameters

string
required
The ID of the article to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_KNOWLEDGE_BASE_CATEGORYDeletes a knowledge base category. This permanently deletes the resource.

Input Parameters

string
required
The ID of the category to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_MESSAGE_TEMPLATEDelete a message template This permanently deletes the resource.

Input Parameters

string
required
The message template ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_MESSAGE_TEMPLATE_FOLDERDelete a message template folder and child folders/templates This permanently deletes the resource.

Input Parameters

string
required
The message template folder id

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_SIGNATUREDelete signature This permanently deletes the resource.

Input Parameters

string
required
The signature ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_TAGDelete a tag. This permanently deletes the resource.

Input Parameters

string
required
The ID of the tag to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DELETE_TIME_OFFDelete a time off. This permanently deletes the resource.

Input Parameters

string
required
The time off ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DOWNLOAD_ARTICLE_ATTACHMENTDownload one article attachment by article ID and attachment ID.

Input Parameters

string
required
The ID of the article
string
required
The ID of the file to download

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_DOWNLOAD_ATTACHMENTDownload an attachment by its link ID, optionally constrained to its comment, message, or message-template parent.

Input Parameters

string
Required only for parent_type=comment; forbidden for every other location.
string
Required only for parent_type=message; forbidden for every other location.
string ("none" | "comment" | "message" | "message_template")
required
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.
Required for every parent_type; the attachment link ID.
string
Required only for parent_type=message_template; forbidden for every other location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_ACCOUNTRetrieve one account by account ID, domain, or external-ID resource alias.

Input Parameters

string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_ANALYTICS_EXPORTFetch an analytics exports. Refer to the Analytics topic for details about specific metrics.

Input Parameters

string
required
The export ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_ANALYTICS_REPORTFetch an analytics report. Refer to the Analytics topic for details about specific metrics.

Input Parameters

string
required
The report UID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_CHANNELRetrieve one channel by channel ID or channel-address resource alias.

Input Parameters

string
required
The Channel ID. Alternatively, you can supply the channel address as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_COMMENTRetrieve one conversation comment by comment ID.

Input Parameters

string
required
The Comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_COMPANY_TEAMMATE_GROUPRetrieve one company teammate group by group ID.

Input Parameters

string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_CONTACTRetrieve one contact by contact ID or source-and-handle resource alias.

Input Parameters

string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_CONVERSATIONRetrieve one conversation by conversation ID.

Input Parameters

string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_CURRENT_IDENTITYFetch the details of the API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_EVENTRetrieve one event by event ID.

Input Parameters

string
required
The event ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_INBOXRetrieve one inbox by inbox ID.

Input Parameters

string
required
The Inbox ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASERetrieve knowledge-base metadata without localized content. Use FRONT_GET_KNOWLEDGE_BASE_CONTENT to retrieve localized content.

Input Parameters

string
required
The ID of the knowledge base to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASE_ARTICLERetrieve article metadata without localized content. Use FRONT_GET_KNOWLEDGE_BASE_ARTICLE_CONTENT to retrieve default- or selected-locale content.

Input Parameters

string
required
The ID of the article to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASE_ARTICLE_CONTENTGet a knowledge-base article with content in its default locale or a specified locale.

Input Parameters

string
The locale of the content to fetch
string
required
The ID of the article to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASE_CATEGORYRetrieve category metadata without localized content. Use FRONT_GET_KNOWLEDGE_BASE_CATEGORY_CONTENT to retrieve default- or selected-locale content.

Input Parameters

string
required
The ID of the category to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASE_CATEGORY_CONTENTGet a knowledge-base category with content in its default locale or a specified locale.

Input Parameters

string
The locale of the content to fetch
string
required
The ID of the category to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_KNOWLEDGE_BASE_CONTENTGet a knowledge base with content in its default locale or a specified locale.

Input Parameters

string
The locale of the content to fetch
string
required
The ID of the knowledge base to fetch

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_MESSAGERetrieve a message as documented JSON, or download the raw email as an EML file when response_format is eml.

Input Parameters

string
required
The message ID
string ("json" | "eml")
Return the documented JSON message, or download an email message as an EML file.

Output

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

string
required
The message ID
string
Opaque cursor returned by a previous call to this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_MESSAGE_TEMPLATERetrieve one message template by template ID.

Input Parameters

string
required
The message template ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_MESSAGE_TEMPLATE_FOLDERFetch a message template folder.

Input Parameters

string
required
The message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_RULERetrieve one Front automation rule by rule ID.

Input Parameters

string
required
The Rule ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_SHIFTFetch a shift. Requires a Front plan with Shifts.

Input Parameters

string
required
The Shift ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_SIGNATURERetrieve one email signature by signature ID.

Input Parameters

string
required
The signature ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_TAGRetrieve one tag by tag ID.

Input Parameters

string
required
The tag ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_TEAMFetch a team (workspace).

Input Parameters

string
required
The Team ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_TEAMMATERetrieve one teammate by teammate ID or email resource alias.

Input Parameters

string
required
The teammate ID. Alternatively, you can supply an email as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_TICKET_STATUSRetrieve one ticket status by status ID.

Input Parameters

string
required
The ticket status ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_TIME_OFFRetrieve one time-off record by time-off ID.

Input Parameters

string
required
The time off ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_GET_VIEWRetrieve one conversation view by view ID.

Input Parameters

string
required
The view ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_IMPORT_INBOX_MESSAGEUse 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 endpoint to send (rather than import) a new message.

Input Parameters

array
List of the recipient handles who will receive a copy of this message
array
required
List of the recipient handles who will receive this message
array
List of the recipient handles who will receive a blind copy of this message
string
required
Body of the message
array
List of tag names to add to the conversation
string ("email" | "sms" | "intercom" | "custom")
Type of the message to import. Default is email.
object
required
Sender details: required handle, plus optional name and outbound-message author_id.
string
Subject of the message
string
required
The Inbox ID
object
required
Import behavior: required is_inbound, plus optional thread_ref, is_archived, and should_skip_rules.
integer
required
Date at which the message as been sent or received.
string
ID of the teammate who will be assigned to the conversation.
array
Files to attach to the imported message, up to 25 MB each. Supply each file using the tool’s file-upload object.
string ("html" | "markdown")
Format of the message body. Can be markdown (default) or html, and can only be specified for email type.
string
required
External identifier of the message. Front won’t import two messages with the same external ID.
string
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_ACCOUNT_CONTACTSLists the contacts associated with an Account

Input Parameters

integer
Max number of results per page
string ("created_at" | "updated_at")
Field used to sort the contacts. Either created_at or updated_at.
string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_ACCOUNTSList the accounts of the company.

Input Parameters

integer
Max number of results per page
string ("created_at" | "updated_at")
Field used to sort the accounts. Either created_at or updated_at.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CATEGORIES_IN_A_KNOWLEDGE_BASEList categories in a knowledge base.

Input Parameters

integer
Max number of results per page
string
Opaque cursor returned by a previous call to this tool.
string
required
The ID of the knowledge base

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CHANNELSList channels globally or for one inbox, team, or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CHILD_MESSAGE_TEMPLATE_FOLDERSFetch the child message templates folders of a message template folder.

Input Parameters

string
Opaque cursor returned by a previous call to this tool.
string
required
The message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CHILD_MESSAGE_TEMPLATESFetch the child message templates of a message template folder.

Input Parameters

string
Opaque cursor returned by a previous call to this tool.
string
required
The message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMMENT_MENTIONSList the teammates mentioned in a comment.

Input Parameters

string
required
The Comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMPANY_TEAMMATE_GROUPSList company teammate groups with their IDs, names, SCIM-management status, contact-list permissions, and membership links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAM_INBOXESList inboxes that the teammate group has access to via its associated teams.

Input Parameters

string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAMMATESList teammates belonging to a specified company teammate group.

Input Parameters

string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMPANY_TEAMMATE_GROUP_TEAMSList teams added to the teammate group. Any teams added to the teammate group will automatically link public inboxes.

Input Parameters

string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_COMPANY_TICKET_STATUSESList company ticket statuses with their IDs, names, and categories for resolving valid status IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONTACT_LISTSList contact lists globally or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONTACT_NOTESList the notes added to a contact.

Input Parameters

string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONTACTSList contacts globally or for one team or teammate.

Input Parameters

integer
Max number of results per page
object
Search query object with the optional properties updated_after and updated_before, whose value should be a timestamp in seconds with up to 3 decimal places.
string ("created_at" | "updated_at")
Field used to sort the contacts. Either created_at or updated_at.
string
Required only for owner_type=team; forbidden for global and teammate.
string ("global" | "team" | "teammate")
required
Contact owner. global forbids both owner IDs; team requires only team_id; teammate requires only teammate_id.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.
string
Required only for owner_type=teammate; forbidden for global and team. A teammate email resource alias is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONTACTS_IN_CONTACT_LISTList the contacts belonging to the requested contact list.

Input Parameters

integer
Max number of results per page
string
Opaque cursor returned by a previous call to this tool.
string
required
The contact list ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_COMMENTSList the comments in a conversation in reverse chronological order (newest first).

Input Parameters

string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_DRAFTSList draft messages in a conversation with cursor-based pagination.

Input Parameters

string
Opaque cursor returned by a previous call to this tool.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_EVENTSList the events that occured for a conversation in reverse chronological order (newest first). The order will respect your company’s bump settings, which determine when conversations bump to the top.

Input Parameters

integer
Max number of results per page
string
Opaque cursor returned by a previous call to this tool.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_FOLLOWERSList the teammates following a conversation.

Input Parameters

string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_INBOXESList the inboxes in which a conversation is listed.

Input Parameters

string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATION_MESSAGESList the messages in a conversation in reverse chronological order (newest first).

Input Parameters

integer
Max number of results per page
string
Field used to sort the messages. Only supports created_at.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CONVERSATIONSList the conversations in the company in reverse chronological order (most recently updated first). The order will respect your company’s bump settings, which determine when conversations bump to the top. For more advanced filtering, see the search endpoint.

Input Parameters

integer
Max number of results per page
object
Search query object 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.
string
Field used to sort the conversations. Only supports date.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_CUSTOM_FIELDSList custom-field definitions for a selected Front resource type.

Input Parameters

string ("account" | "contact" | "conversation" | "inbox" | "link" | "teammate")
required
Select which documented Front endpoint context to use.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_EVENTSList a page of company inbox events, with optional filters and sorting. Use the returned cursor to retrieve further pages.

Input Parameters

integer
Max number of results per page (max 15)
object
Search query object 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. inboxes should be a list of inbox IDs.
string
Field used to sort the events. Only supports created_at.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_INBOX_ACCESSList the teammates with access to an inbox.

Input Parameters

string
required
The Inbox ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_INBOXESList the inboxes of the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_KNOWLEDGE_BASE_ARTICLESList articles in a knowledge base or in one knowledge-base category.

Input Parameters

integer
Max number of results per page
string
Required only for parent_type=category; forbidden for parent_type=knowledge_base.
string
Opaque cursor returned by a previous call to this tool.
string ("knowledge_base" | "category")
required
Article parent. knowledge_base requires only knowledge_base_id and forbids category_id; category requires only category_id and forbids knowledge_base_id.
string
Required only for parent_type=knowledge_base; forbidden for parent_type=category.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_KNOWLEDGE_BASESList the knowledge bases of the company.

Output

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

integer
Max number of results per page
string
Opaque cursor returned by a previous call to this tool.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_MESSAGE_TEMPLATE_FOLDERSList message-template folders globally or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_MESSAGE_TEMPLATESList message templates globally or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_RULESList rules globally, company-wide, or for one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_SHIFTSList shifts globally or for one team or teammate; requires a Front plan with Shifts.

Input Parameters

string
Required only for owner_type=team; forbidden for global and teammate.
string ("global" | "team" | "teammate")
required
Shift owner. global forbids both owner IDs; team requires only team_id; teammate requires only teammate_id.
string
Required only for owner_type=teammate; forbidden for global and team. A teammate email resource alias is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_SHIFTS_TEAMMATESList the teammates assigned to a shift. Requires a Front plan with Shifts.

Input Parameters

string
required
The Shift ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_SIGNATURESList signatures owned by one team or teammate.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TAG_CHILDRENList the direct child tags beneath a specified parent tag.

Input Parameters

string
required
The tag ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TAGSList tags globally, company-wide, or for one team or teammate.

Input Parameters

integer
Max number of results per page
string
Field used to sort the tags. Only supports id.
string
Required only for owner_type=team; forbidden for global, company, and teammate.
string ("global" | "company" | "team" | "teammate")
required
Tag owner. global and company forbid both owner IDs; team requires only team_id; teammate requires only teammate_id.
string ("asc" | "desc")
Order by which results should be sorted
string
Opaque cursor returned by a previous call to this tool.
string
Required only for owner_type=teammate; forbidden for global, company, and team. A teammate email resource alias is accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TEAM_INBOXESList the inboxes belonging to a team (workspace).

Input Parameters

string
required
The team ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TEAMMATE_PRIVATE_INBOXESList private inboxes owned by a specified teammate.

Input Parameters

string
required
The teammate ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TEAMMATESList company teammates for teammate discovery and ID resolution. The tool returns a single response and does not provide pagination controls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TEAMSList the teams (workspaces) in the company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_TIME_OFFSList time-off records for one team or teammate.

Input Parameters

integer
Max number of results per page
object
Search query object with the optional properties active_from and active_until, whose value should be a timestamp in seconds with up to 3 decimal places.
string
Required for owner_type=team; forbidden for owner_type=teammate.
string ("team" | "teammate")
required
Time-off owner. team requires only team_id and forbids teammate_id; teammate requires only teammate_id and forbids team_id.
string
Opaque cursor returned by a previous call to this tool.
string
Required for owner_type=teammate; forbidden for owner_type=team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_LIST_VIEWSList views globally or for one team.

Input Parameters

integer
Max number of results per page
string
Required for owner_type=team; forbidden for owner_type=global.
string ("global" | "team")
required
View owner. global forbids team_id; team requires team_id.
string
Opaque cursor returned by a previous call to this tool.

Output

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

string
required
The message ID

Output

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

array
required
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.
string
Optional contact ID to merge the other contacts into.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_RECEIVE_CUSTOM_MESSAGESReceive a custom message in Front. This endpoint is available for custom channels ONLY.

Input Parameters

string
required
Body of the message
object
required
Sender details: required handle, plus optional name and Front contact_id.
string
Subject of the message
object
Optional metadata: thread_ref controls custom-channel threading, and headers stores arbitrary key-value information with the message.
string
required
The channel ID. Alternatively, you can supply the channel address as a resource alias.
array
Files to attach, up to 25 MB each.
string ("html" | "markdown")
Format of the message body. Can be markdown (default) or html.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REFRESH_APPLICATION_OBJECTSRefresh or update existing application objects that match an exact pattern. This does not create new application objects.

Input Parameters

string
Optional link name. An installed links integration may override it.
string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAM_INBOXESUnlinks non-public inboxes from the teammate group.

Input Parameters

array
required
IDs of the non-public inboxes to unlink from the teammate group.
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAMMATESRemove teammate group teammates. Note - You cannot modify a teammate group that is managed by SCIM.

Input Parameters

array
required
IDs of the teammates to remove from the teammate group.
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_COMPANY_TEAMMATE_GROUP_TEAMSRemove teams from the teammate group. Unlinks to any associated team inboxes.

Input Parameters

array
required
IDs of the teams to remove from the teammate group.
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_CONTACT_FROM_ACCOUNTRemoves a list of contacts from an Account

Input Parameters

string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
array
required
The contact IDs to include. Alternatively, you can supply the contact source and handle as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_CONTACTS_FROM_CONTACT_LISTRemove specified contact IDs or source-and-handle resource aliases from a contact list.

Input Parameters

array
required
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.
string
required
The contact list ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_CONVERSATION_FOLLOWERSRemoves teammates from the list of followers of a conversation.

Input Parameters

array
required
IDs of the teammate to remove from the followers list. Alternatively, you can supply the teammates as a resource alias.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_CONVERSATION_TAGRemoves one or more tags to a conversation

Input Parameters

array
required
IDs of the tags to remove from the conversation.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_INBOX_ACCESSRemove access of one or more teammates from an inbox.

Input Parameters

string
required
The Inbox ID
array
required
IDs of the teammates whose access to the inbox should be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_TEAMMATES_FROM_SHIFTRemove teammates from a shift. Requires a Front plan with Shifts.

Input Parameters

string
required
The Shift ID
array
required
IDs of the teammates to remove from the shift.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_REMOVE_TEAMMATES_FROM_TEAMRemove one or more teammates from a team (workspace).

Input Parameters

string
required
The Team ID
array
required
IDs of the teammates to remove from the team.

Output

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

array
List of the recipient handles who will receive a copy of this message
array
List of the recipient handles who will receive this message
array
List of the recipient handles who will receive a copy of this message
string
required
Body of the message
string
Text version of the body for email messages
object
Optional reply behavior: tag_ids adds tags to the conversation and archive archives it immediately after sending.
string
Subject of the message for email message
string
ID of the teammate on behalf of whom the answer is sent
string
Channel ID the message is sent from
string
Body for the quote that the message is referencing. Only available on email channels.
array
Files to attach, up to 25 MB each.
string
Name used for the sender info of the message
string
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.
string
required
The conversation ID
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_SEARCH_CONVERSATIONSSearch for conversations using Front search syntax, returning paginated results in descending order by last activity. This endpoint is subject to proportional rate limiting at 40% of the company’s rate limit.

Input Parameters

integer
Max number of results per page
string
required
Search query string. See Search topic for usage details.
string
Opaque cursor returned by a previous call to this tool.

Output

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

array
List of the recipient handles who will receive a copy of this message. One of to, cc, or bcc is required.
array
List of the recipient handles who will receive this message. One of to, cc, or bcc is required.
array
List of the recipient handles who will receive a blind copy of this message. One of to, cc, or bcc is required.
string
required
Body of the message
string
Text version of the body for email messages
object
Optional send behavior: tag_ids adds tags to the new conversation and archive archives it immediately after sending.
string
Subject of the message for email message
string
ID of the teammate on behalf of whom the answer is sent
string
required
The sending channel ID. Alternatively, you can supply the sending channel address as a resource alias.
array
Files to attach, up to 25 MB each.
string
Name used for the sender info of the message
string
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.
boolean
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

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

boolean
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.
object
required
Application object associated with the trigger. Provide at least one identifier: id or ext_link; if both are supplied, Front favors id.
string
required
Event type configured in the application’s trigger settings.
object
Additional event properties exposed to the triggered Front workflow as dynamic variables.
string
required
The application UID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_ACCOUNTUpdate an account’s name, description, domains, or custom fields.

Input Parameters

string
Name of the Account
array
List of domains associated with the Account
string
required
The Account ID. Alternatively, you can supply the account domain or external ID as a resource alias.
string
Account description
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_CHANNELUpdate a channel’s name or settings, or move it to another inbox together with its conversations.

Input Parameters

string
Name of the channel
string
ID of the inbox to move this channel to. Will also move corresponding conversations.
object
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.
string
required
The Channel ID. Alternatively, you can supply the channel address as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_COMMENTUpdate a comment in a conversation.

Input Parameters

string
Content of the comment. Can include markdown formatting. Can only be updated if the comment was created using the same token.
boolean
Whether or not the comment is pinned in its conversation.
string
required
The Comment ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_COMPANY_TEAMMATE_GROUPUpdates a teammate group. Note - You cannot modify a teammate group that is managed by SCIM.

Input Parameters

string
Name of the teammate group
string
Description of the teammate group
object
Permissions for the teammate group
string
required
The teammate group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_CONTACTUpdate a contact’s profile, links, list memberships, and custom fields; missing named groups may be created.

Input Parameters

string
Contact name
List of all the links of the contact
object
Replacement avatar image upload, up to 25 MB.
string
required
The contact ID. Alternatively, you can supply the contact’s source and handle as a resource alias.
array
List of all the contact list names the contact belongs to. It will automatically create missing groups
string
Contact description
array
List of all the group names the contact belongs to. It will automatically create missing groups. ⚠️ Deprecated. Use list_names instead.
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_CONVERSATIONUpdate a conversation’s assignee, inbox, status, tags, task details, due date, or custom fields. Supplied tag IDs replace the conversation’s existing tags.

Input Parameters

number
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.
string ("archived" | "open" | "deleted" | "spam")
New status of the conversation
array
List of all the tag IDs replacing the old conversation tags
string
ID of the inbox to move the conversation to.
string
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.
string
ID of the teammate to assign the conversation to. Set it to null to unassign.
string
Description of the task. Only allowed on task conversations. Set to null to clear.
object
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
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_CONVERSATION_ASSIGNEEAssign or unassign a conversation.

Input Parameters

string
required
ID of the teammate to assign the conversation to. Set it to null to unassign.
string
required
The conversation ID

Output

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

boolean
Set true to cancel the reminder by sending scheduled_at: null. Cannot be combined with a timestamp.
string
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.
string
required
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.
number
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.
string
required
The conversation ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_DRAFTUpdate an existing shared draft’s body, recipients, channel, attachments, signature, subject, and version.

Input Parameters

array
List of recipient handles who will receive a copy of the message once the draft is sent
array
List of recipient handles who will receive the message once the draft is sent
array
List of the recipient handles who will receive a blind copy of the message once the draft is sent
string
required
Body of the draft
string
Mode of the draft to update. Can only be ‘shared’ (draft is visible to all teammates with access to the conversation).
string
Subject of the draft.
string
Version of the draft
string
ID of the teammate on behalf of whom the draft will be created. Alternatively, you can supply the author ID as a resource alias. If omitted, will post as the API Token or Application making the request.
string
required
ID of the channel from which the draft will be sent. Alternatively, you can supply the channel address as a resource alias.
string
required
The draft ID
string
Body for the quote that the message is referencing. Only available on email channels.
array
Files to attach, up to 25 MB each.
string
ID of the signature to attach to this draft. If null, no signature is attached.
boolean
Whether or not Front should try to resolve a signature for the message. Is ignored if signature_id is included. Default false;

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_KNOWLEDGE_BASE_ARTICLE_CONTENTUpdate article content in its default locale or a specified locale.

Input Parameters

string
The locale of the updated content
string ("draft" | "published")
Article status
string
required
HTML content of the article
string
Subject of the article
string
required
Teammate ID of the article author
string
required
The ID of the article to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_KNOWLEDGE_BASE_CATEGORY_CONTENTUpdate category content in its default locale or a specified locale.

Input Parameters

string
Name of the knowledge base category
string
The locale of the updated content
string
required
The ID of the category to update
string
Description of the knowledge base category

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_KNOWLEDGE_BASE_CONTENTUpdate knowledge-base content in its default locale or a specified locale.

Input Parameters

string
required
Name of the knowledge base
string
The locale of the updated content
string
required
The ID of the knowledge base to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_MESSAGE_TEMPLATEUpdate a message template’s name, subject, body, parent folder, inbox availability, or attachments.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_MESSAGE_TEMPLATE_FOLDERUpdate message template folder

Input Parameters

string
Name of the message template folder
string
ID of the parent folder to be placed into. Goes into the root folder if unspecified or if null.
string
required
The message template folder ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_SHIFTUpdate a shift. Requires a Front plan with Shifts.

Input Parameters

string
Name of the shift
string ("black" | "grey" | "pink" | "purple" | "blue" | "teal" | "green" | "yellow" | "orange" | "red")
Color of the shift
object
Replacement shift intervals by weekday. Each included day requires start and end strings interpreted in the shift’s IANA timezone.
string
required
The Shift ID
string
A timezone name as defined in the IANA tz database
array
List of all the teammate ids who will be part of this shift. Alternatively, you can supply emails as a resource alias.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_SIGNATUREUpdate a signature’s name, sender information, body, visibility, default status, or channel availability.

Input Parameters

string
Body of the signature
string
Name of the signature
boolean
If true, the signature will be set as the default signature for the team or teammate.
array
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.
string
Sender info of the signature that will appear in the From line of emails sent.
string
required
The signature ID
boolean
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_TAGUpdate a tag’s name, description, color, parent, or conversation-list visibility.

Input Parameters

string
Name of the tag
string
required
The tag ID
string ("grey" | "pink" | "red" | "orange" | "yellow" | "green" | "light-blue" | "blue" | "purple")
Highlight color of the tag.
string
Description of the tag
string
ID of the parent of this tag. Set to null to remove the parent tag.
boolean
Whether the tag is visible in conversation lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_TEAMMATEUpdate a teammate’s username, name, availability, or custom fields.

Input Parameters

string
New username. It must be unique and can only contains lowercase letters, numbers and underscores.
string
New last name
string
New first name
string
required
The teammate ID. Alternatively, you can supply an email as a resource alias.
boolean
New availability status
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_TIME_OFFUpdate a time-off record’s name, dates, or auto-responder settings.

Input Parameters

string
Name of the time off
number
Timestamp when the time off ends (in seconds), or null to clear it
number
Timestamp when the time off starts (in seconds)
string
required
The time off ID
object
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_UPDATE_VIEWUpdate a conversation view’s name, inbox filters, tag filters, assignee filters, exclusions, no-tag setting, or highlight color.

Input Parameters

string
Name of the view
boolean
Whether to filter for conversations without tags
array
List of tag IDs to filter by
string
required
The view ID
string
Color highlight for the view
array
List of inbox IDs to filter by
array
List of tag IDs to exclude
array
List of assignee IDs to filter by
array
List of assignee IDs to exclude

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FRONT_VALIDATE_CHANNELAsynchronously validate an SMTP channel (this endpoint is irrelevant to other channel types). When you create an SMTP channel via the API, create a channel with type smtp and the send_as set to the needed email address. You then configure the email provider, after which you use this endpoint to asynchronously validate the SMTP settings.

Input Parameters

string
required
The Channel ID. Alternatively, you can supply the channel address as a resource alias.

Output

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