POST
/
v1
/
conversations

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
channel_id
string
required

Identifier of the channel through which the conversation is taking place.

is_unread
boolean

Whether the conversation has been read.

label_ids
string[]
required

List of labels for this conversation

last_message_date
string

ISO 8601 time of the most recent message.

participants
object[]
required
priority
enum<string>

Priority of the conversation

Available options:
no_priority,
urgent,
high,
medium,
low
snippet
string

A shortened plain-text preview of the message body.

status
enum<string>

Status of the conversation

Available options:
open,
done,
trash,
spam
subject
string

Subject of the conversation, if applicable. Null for non-email conversations.

Response

200 - application/json
attachment_count
integer

The number of attachments in this conversation.

channel_id
string
required

Identifier of the channel through which the conversation is taking place.

created_at
string
required

The ISO 8601 time at which the Conversation was created.

draft_count
integer

The number of drafts in this conversation.

external_conversation_id
string

The identifier of the conversation in an external system.

id
string
required

Unique identifier of the conversation.

is_unread
boolean

Whether the conversation has been read.

labels
object[]
required

List of labels for this conversation

last_message_date
string

ISO 8601 time of the most recent message.

message_count
integer

The number of messages in this conversation.

participants
object[]
required
priority
enum<string>
required

Priority of the conversation

Available options:
no_priority,
urgent,
high,
medium,
low
snippet
string

A shortened plain-text preview of the message body.

status
enum<string>
required

Status of the conversation

Available options:
open,
done,
trash,
spam
subject
string

Subject of the conversation, if applicable. Null for non-email conversations.