Skip to main content
POST
Create conversation

Authorizations

api_access_token
string
header
required

Path Parameters

account_id
integer
required

The numeric ID of the account

Body

application/json
source_id
string
required

Conversation source id

Example:

"1234567890"

inbox_id
integer
required

Id of inbox in which the conversation is created
Allowed Inbox Types: Website, Phone, Api, Email

Example:

1

contact_id
integer

Contact Id for which conversation is created

Example:

1

additional_attributes
object

Lets you specify attributes like browser information

Example:
custom_attributes
object

The object to save custom attributes for conversation, accepts custom attributes key and value

Example:
status
enum<string>

Specify the conversation whether it's pending, open, closed

Available options:
open,
resolved,
pending
Example:

"open"

assignee_id
integer

Agent Id for assigning a conversation to an agent

Example:

1

team_id
integer

Team Id for assigning a conversation to a team\

Example:

1

snoozed_until
string<date-time>

Snoozed until date time

Example:

"2030-07-21T17:32:28Z"

message
object

The initial message to be sent to the conversation

Response

Created

id
number

ID of the conversation

messages
object[]
account_id
number

Account Id

uuid
string

UUID of the conversation

additional_attributes
object

The object containing additional attributes related to the conversation

agent_last_seen_at
number

The last activity at of the agent

assignee_last_seen_at
number

The last activity at of the assignee

can_reply
boolean

Whether the conversation can be replied to

contact_last_seen_at
number

The last activity at of the contact

custom_attributes
object

The object to save custom attributes for conversation, accepts custom attributes key and value

inbox_id
number

ID of the inbox

labels
string[]

The labels of the conversation

muted
boolean

Whether the conversation is muted

snoozed_until
number

The time at which the conversation will be unmuted

status
enum<string>

The status of the conversation

Available options:
open,
resolved,
pending
created_at
number

The time at which conversation was created

updated_at
number

The time at which conversation was updated

timestamp
string

The time at which conversation was created

first_reply_created_at
number

The time at which the first reply was created

unread_count
number

The number of unread messages

last_non_activity_message
object
last_activity_at
number

The last activity at of the conversation

priority
string

The priority of the conversation

waiting_since
number

The time at which the conversation was waiting

sla_policy_id
number

The ID of the SLA policy

applied_sla
object

The applied SLA

sla_events
object[]
meta
object