Front

Writes

• Reply to conversation

  read back

  front-reply-to-conversation

  Send a reply in one conversation, to its current recipients, from the conversation's channel. The customer receives it. Optionally sent as a teammate (author_id). The conversation is not archived. Front accepts the reply and creates the message a moment later.

• Create draft reply

  read back

  front-create-draft-reply

  Create a draft reply to the last message in a conversation, from one channel, shared with the team. Nothing is sent: a teammate reviews and sends it in Front.

• Add comment

  read back

  front-add-comment

  Add an internal comment to a conversation, optionally as a teammate. Teammates see it; the customer never does. Markdown works.

• Assign conversation

  read back

  front-assign-conversation

  Assign a conversation to one teammate, replacing the current assignee.

• Unassign conversation

  read back

  front-unassign-conversation

  Remove the assignee from a conversation. Pass the teammate it is assigned to now (assignee.id from get-conversation).

• Archive conversation

  read back

  front-archive-conversation

  Archive a conversation. It leaves the open view and comes back when the customer writes again.

• Reopen conversation

  read back

  front-reopen-conversation

  Reopen an archived conversation.

• Tag conversation

  read back

  front-tag-conversation

  Add one existing tag to a conversation. The other tags stay.

• Create contact

  read back

  front-create-contact

  Create a company contact with a name and one email address, optionally a description.

• Rename contact

  read back

  front-rename-contact

  Replace a contact's name.

• Set contact description

  read back

  front-set-contact-description

  Replace a contact's description.

• Add contact note

  acknowledged

  front-add-contact-note

  Add a note to a contact, written as one teammate. Teammates see it in the contact's details.

Reads

• Search conversations

  front-search-conversations

  Search conversations with Front's search syntax, newest activity first: for example `is:open inbox:inb_123`, `from:pam@example.com` or `tag:tag_123 refund`. Returns _total and up to 10 conversations a page, each with its status, assignee, recipient and tags. When _pagination.next is set, pass its page_token value as page_token. Front limits this endpoint to a share of the company's rate limit.

• Get conversation

  front-get-conversation

  Get one conversation: subject, status (assigned, unassigned, archived), assignee, recipient, tags, links and custom fields. A merged conversation answers with a redirect to the one it was merged into.

• List conversation messages

  front-list-conversation-messages

  List the messages in a conversation, newest first: sender and recipients, subject, HTML body and text, whether it was inbound, and attachment names. 5 a page, because bodies are long; a very long body can still be cut at the response limit. When _pagination.next is set, pass its page_token value as page_token.

• Get message

  front-get-message

  Get one message by id: sender and recipients, subject, HTML body, text, whether it was inbound, and attachment names. Attachments themselves are not downloaded.

• List conversation comments

  front-list-conversation-comments

  List the internal comments on a conversation, newest first: author, body and when it was posted. Customers never see comments. Front returns them all in one response, so a very long discussion can be cut at the response limit.

• List inboxes

  front-list-inboxes

  List the inboxes the token can see, with id and name. Use an id in a search (`inbox:inb_123`). Front returns them all in one response.

• List channels

  front-list-channels

  List the channels the token can see (email addresses, chat and SMS channels), with id, type, address and inbox. A draft reply needs a channel id. Front returns them all in one response.

• List teammates

  front-list-teammates

  List the company's teammates: id, email, username, name, and whether they are available. Use an id to assign a conversation or to write as a teammate. Front returns them all in one response, so a very large company's list can be cut at the response limit.

• List tags

  front-list-tags

  List the tags the token can see (company, team and teammate tags): id, name and description. 50 a page. When _pagination.next is set, pass its page_token value as page_token.

• Get contact

  front-get-contact

  Get one contact by id: name, description, handles (email, phone and other addresses), the contact lists it is in, links and custom fields.

• Find contact by email

  front-find-contact-by-email

  Get the contact that has this email address as a handle, the same fields as get-contact. Front answers 404 when no contact has it.

• List contact conversations

  front-list-contact-conversations

  List one contact's conversations, newest first, with status, assignee and tags. 10 a page. When _pagination.next is set, pass its page_token value as page_token.

• List contact notes

  front-list-contact-notes

  List the notes teammates added to a contact: author, body and when it was added. Front returns them all in one response.