Conversations

Create Conversation

post/api/v1/conversations

Request body

subjectstring

Conversation subject

contentstring required

Initial message content (Accepts HTML as well)

inbox_idinteger required

Inbox ID for the conversation

team_idinteger nullable

Team ID to be assigned when conversation is created

agent_idinteger nullable

Agent ID to be assigned when conversation is created

contact_emailstring email required

Contact's email address

first_namestring required

Contact's first name

last_namestring

Contact's last name

external_user_idstring

External identifier for the contact in your own system

attachmentsinteger[]

Array of attachment IDs

initiator'agent' | 'contact' required

Who initiated the conversation. 'contact' means the first message is treated as an incoming message from the contact; 'agent' means the first message is an outgoing reply from the agent. Automation rules are only evaluated for contact-initiated conversations (incoming messages); agent-initiated conversations skip automation rule evaluation.

custom_attributesobject

Arbitrary key-value custom attributes to set on the conversation

Example request

{
  "external_user_id": "crm-9f3a21",
  "custom_attributes": {
    "order_id": "A-1024",
    "plan": "pro"
  }
}

Response

Conversation created successfully

statusstring

Example response

{
  "status": "success",
  "data": {
    "id": 51,
    "uuid": "7d692b95-73dc-4f53-9343-6ed47a3db903",
    "reference_number": "150",
    "status": "Open",
    "subject": "[GitHub] A third-party GitHub Application has been added",
    "inbox_mail": "support@example.com",
    "inbox_name": "Support Inbox",
    "inbox_channel": "email",
    "last_message": "Hey! A third-party GitHub Application was recently authorized...",
    "last_message_sender": "contact"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.