Skip to main content
POST
/
api
/
v1
/
conversations
Create Conversation
curl --request POST \
  --url http://localhost:8080/api/v1/conversations \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "subject": "<string>",
  "content": "<string>",
  "inbox_id": 123,
  "team_id": 123,
  "agent_id": 123,
  "contact_email": "[email protected]",
  "first_name": "<string>",
  "last_name": "<string>",
  "attachments": [
    123
  ],
  "initiator": "agent"
}'
{
  "status": "success",
  "data": {
    "id": 51,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "uuid": "7d692b95-73dc-4f53-9343-6ed47a3db903",
    "contact_id": 123,
    "inbox_id": 123,
    "closed_at": "2023-11-07T05:31:56Z",
    "resolved_at": "2023-11-07T05:31:56Z",
    "reference_number": "150",
    "priority": "<string>",
    "priority_id": 123,
    "status": "Open",
    "status_id": 123,
    "first_reply_at": "2023-11-07T05:31:56Z",
    "last_reply_at": "2023-11-07T05:31:56Z",
    "assigned_user_id": 123,
    "assigned_team_id": 123,
    "assignee_last_seen_at": "2023-11-07T05:31:56Z",
    "waiting_since": "2023-11-07T05:31:56Z",
    "subject": "[GitHub] A third-party GitHub Application has been added",
    "inbox_mail": "[email protected]",
    "inbox_name": "Support Inbox",
    "inbox_channel": "email",
    "tags": [
      "<string>"
    ],
    "meta": [
      {}
    ],
    "custom_attributes": {},
    "last_message_at": "2023-11-07T05:31:56Z",
    "last_message": "Hey! A third-party GitHub Application was recently authorized...",
    "last_message_sender": "contact",
    "contact": {
      "id": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[email protected]",
      "type": "<string>",
      "availability_status": "<string>",
      "avatar_url": "<string>",
      "phone_number": "<string>",
      "phone_number_country_code": "<string>",
      "custom_attributes": {},
      "enabled": true,
      "last_active_at": "2023-11-07T05:31:56Z",
      "last_login_at": "2023-11-07T05:31:56Z",
      "roles": [
        "<string>"
      ],
      "permissions": [
        "<string>"
      ],
      "teams": [
        {}
      ],
      "api_key": "<string>",
      "api_key_last_used_at": "2023-11-07T05:31:56Z"
    },
    "sla_policy_id": 123,
    "sla_policy_name": "<string>",
    "applied_sla_id": 123,
    "first_response_deadline_at": "2023-11-07T05:31:56Z",
    "resolution_deadline_at": "2023-11-07T05:31:56Z",
    "next_response_deadline_at": "2023-11-07T05:31:56Z",
    "next_response_met_at": "2023-11-07T05:31:56Z",
    "previous_conversations": [
      {
        "id": 123,
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "uuid": "<string>",
        "contact": {
          "first_name": "<string>",
          "last_name": "<string>",
          "avatar_url": "<string>"
        },
        "last_message": "<string>",
        "last_message_at": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Body

application/json

Conversation creation details

​
subject
string
required

Conversation subject

​
content
string
required

Initial message content (Accepts HTML as well)

​
inbox_id
integer
required

Inbox ID for the conversation

​
contact_email
string<email>
required

Contact's email address

​
first_name
string
required

Contact's first name

​
last_name
string
required

Contact's last name

​
initiator
enum<string>
required

Who initiated the conversation. 'contact' means first message is incoming from contact, 'agent' means first message is outgoing from agent

Available options:
agent,
contact
​
team_id
integer | null

Team ID to be assigned when conversation is created

​
agent_id
integer | null

Agent ID to be assigned when conversation is created

​
attachments
integer[]

Array of attachment IDs

Response

Conversation created successfully

​
status
string
Example:

"success"

​
data
object
⌘I