Front tools
The 13 Front operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- Search conversationsGETSearches the conversations the API token can reach, most recent activity first, and returns _total with the matches. Trashed conversations are left out unless the query asks for is:trashed. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Get conversationGETReturns a conversation with its subject, status, assignee, main recipient, tags, custom fields and links. The messages come from List conversation messages.
- List conversation messagesGETLists the messages of a conversation, newest first unless sort_order is asc, with author, recipients, subject, body and attachment details. The next page comes from the page_token inside _pagination.next, which is null on the last page.
- Update conversationPATCHUpdates the assignee, inbox, status, tags or custom fields of a conversation. Send only the fields to change. tag_ids replaces every tag of the conversation, so use Apply tags to add tags without removing the others.
- Apply tagsPOSTAdds one or more tags to a conversation and keeps the tags it already has.
- Create commentPOSTAdds an internal comment to a conversation. Comments are seen only by teammates, never by the contact. The body accepts Markdown.
- Create draftPOSTCreates a draft reply to the last message of a conversation, for a teammate to review and send in Front. Nothing is sent. A private draft is visible only to its author, so set author_id to the teammate who will review it, or use mode shared.
- Reply to conversationPOSTSends a reply in a conversation right away and answers 202 with a message_uid. Front archives the conversation when the reply goes out, unless options.archive is false. Needs the send permission on the API token. A merged conversation answers with a redirect to the conversation it was merged into.
- Send messagePOSTSends a new message from a channel, which starts a new conversation, and answers 202 with a message_uid. It goes out right away, and Front archives the new conversation unless options.archive is false. Needs the send permission on the API token.
- List channelsGETLists the channels of the company, such as email addresses, SMS numbers and chat, with id, name, address, type and the link to their inbox. The id is the channel_id of Send message and Create draft.
- List inboxesGETLists the inboxes of the company with id and name. The id is the inbox_id of Update conversation and the inbox: filter of Search conversations.
- List teammatesGETLists the teammates of the company with id, email, username, name and availability. The id is the assignee_id and author_id of the other tools and the assignee: filter of Search conversations.
- List tagsGETLists the company, team and personal tags the API token can reach, with id, name and description. The id goes in tag_ids and in the tag: filter of Search conversations.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
