Conversation

Properties

Property	Type	Description
`id`	String	ID of the conversation.
`type`	String	Type of the messages in the conversation.
`status`	String	Status of the conversation for the current teammate.
`subject`	String (optional)	Subject of the conversation.
`blurb`	String (optional)	Blurb of the latest message in the conversation.
`assignee`	Teammate (optional)	Teammate assigned to the conversation, if any.
`recipient`	Recipient (optional)	Main recipient of the conversation.
`inboxes`	Array of Inbox	Inboxes the conversation is listed in.
`tags`	Array of Tag	Tags attached to the conversations.
`topics`	Array of Topic.	[Deprecated] Please use links instead Topics attached to the conversation.
`draftId`	String (optional)	ID of the draft message on this conversation, if any.
`links`	Array of Links	Links attached to the conversation.
`statusId`	String	The ID of the ticket status that applies to the conversation. Only present if ticketing is enabled for the company.
`statusCategory`	String	The category of the ticket status: `open`, `waiting`, or `resolved`.
`ticketIds`	Array of strings	The IDs of the tickets associated with the conversation.
`customFieldAttributes`	Array of CustomField	The custom fields belonging to the conversation.

Conversation status

Front supports per teammate conversation status, allowing each teammate to go through their inbox individually. The status exposed to the plugin SDK is the status as seen by the current teammate which may or may not match the status of another teammate.

A conversation's status can be one of:

archived
open
trashed for conversations that have been moved to trash.
spam for conversation marked as spam.

Ticket status

If ticketing is enabled for a company, conversations can be associated with unique ticketIds.

The statusId returns the ID of the ticket status that the conversation is currently in, and the statusCategory returns whether the ticket status is considered open, waiting, or resolved.

For example, you might configure a custom ticket status called "Priority" with a status ID of sts_5z. This status might belong to the open category. In this example, a conversation might return an array of ticketIDs set to ["TICKET-1"] with a statusId of sts_5z and statusCategory of open.

Conversation type

Front is able to manage multiple types of channels. The type of channel used will define the type of conversation.

A conversation's type can be one of:

email for emails
tweet for public Tweets
twitter_dm for private Direct Message on Twitter
phone_call for a phone call.
sms for text messages.
google_play for Google Play reviews
facebook for Facebook Messenger
intercom for Intercom messages
smooch for Smooch messages.
custom for Custom channels on Front.
whatsapp for Whatsapp messages.
front_chat for Front Chat