A conversation is a unique thread of messages. It can appear in one or more inboxes (eg: if you receive an email on [email protected] where [email protected] is CC'd).
Even if a conversation's messages has multiple recipients, the conversation resource will always have only one. The main recipient of a conversation can change over the time depending on each message received. It will generally be the sender of the last incoming message.
Opening a conversation in Front
To open a conversation in Front you need to open the URL https://app.frontapp.com/open/{conversation_id}
Search Parameters
Conversations support search queries via parameter named q
Name | Type | Description |
---|---|---|
statuses | array (optional) | List of the statuses of the conversations you want to list. Can be assigned , unassigned , archived or deleted |
Example Conversation Object
{
"_links": {
"self": "https://api2.frontapp.com/conversations/cnv_55c8c149",
"related": {
"events": "https://api2.frontapp.com/conversations/cnv_55c8c149/events",
"followers": "https://api2.frontapp.com/conversations/cnv_55c8c149/followers",
"messages": "https://api2.frontapp.com/conversations/cnv_55c8c149/messages",
"comments": "https://api2.frontapp.com/conversations/cnv_55c8c149/comments",
"inboxes": "https://api2.frontapp.com/conversations/cnv_55c8c149/inboxes"
}
},
"id": "cnv_55c8c149",
"subject": "You broke my heart, Hubert.",
"status": "archived",
"assignee": {
"_links": {
"self": "https://api2.frontapp.com/teammates/tea_55c8c149",
"related": {
"inboxes": "https://api2.frontapp.com/teammates/tea_55c8c149/inboxes",
"conversations": "https://api2.frontapp.com/teammates/tea_55c8c149/conversations"
}
},
"id": "tea_55c8c149",
"email": "[email protected]",
"username": "leela",
"first_name": "Leela",
"last_name": "Turanga",
"is_admin": true,
"is_available": true,
"is_blocked": false
},
"recipient": {
"_links": {
"related": {
"contact": "https://api2.frontapp.com/contacts/crd_55c8c149"
}
},
"handle": "[email protected]",
"role": "to"
},
"tags": [
{
"_links": {
"self": "https://api2.frontapp.com/tags/tag_55c8c149",
"related": {
"conversations": "https://api2.frontapp.com/tags/tag_55c8c149/conversations",
"owner": "https://api2.frontapp.com/teams/tim_55c8c149",
"children": "https://api2.frontapp.com/tags/tag_55c8c149/children"
}
},
"id": "tag_55c8c149",
"name": "Robots",
"highlight": "blue",
"is_private": false,
"created_at": 0,
"updated_at": 0
}
],
"last_message": {
"_links": {
"self": "https://api2.frontapp.com/messages/msg_55c8c149",
"related": {
"conversation": "https://api2.frontapp.com/conversations/cnv_55c8c149",
"message_replied_to": "https://api2.frontapp.com/messages/msg_1ab23cd4"
}
},
"id": "msg_55c8c149",
"type": "email",
"is_inbound": true,
"is_draft": false,
"created_at": 1453770984.123,
"blurb": "Anything less than immortality is a...",
"author": {
"_links": {
"self": "https://api2.frontapp.com/teammates/tea_55c8c149",
"related": {
"inboxes": "https://api2.frontapp.com/teammates/tea_55c8c149/inboxes",
"conversations": "https://api2.frontapp.com/teammates/tea_55c8c149/conversations"
}
},
"id": "tea_55c8c149",
"email": "[email protected]",
"username": "leela",
"first_name": "Leela",
"last_name": "Turanga",
"is_admin": true,
"is_available": true,
"is_blocked": false
},
"recipients": [
{
"_links": {
"related": {
"contact": "https://api2.frontapp.com/contacts/crd_55c8c149"
}
},
"handle": "[email protected]",
"role": "to"
}
],
"body": "Anything less than immortality is a complete waste of time.",
"text": "Anything less than immortality is a complete waste of time.",
"attachments": [
{
"filename": "attachment.jpg",
"url": "https://api2.frontapp.com/download/fil_55c8c149",
"content_type": "image/jpeg",
"size": 10000,
"metadata": {
"is_inline": true,
"cid": "123456789"
}
}
],
"metadata": {}
},
"created_at": 1453770984.123,
"is_private": false
}