Create a new conversation

Develop Env

http://localhost:3030

POST

/platform/api/v1/conversations

Create a new conversation for a contact in an inbox. This endpoint is designed for external ticketing services
or other integrations that need to programmatically create conversations.

The platform app must have access to the account associated with the inbox.

Request

Authorization

API Key

Add parameter in header

api_access_token

Example:

api_access_token: ********************

Body Params application/json; charset=utf-8Required

Examples

Responses

🟢201

application/json; charset=utf-8

Conversation created successfully

Body

🟠400

🟠401

🟠403

🟠404

🟠422

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://localhost:3030/platform/api/v1/conversations' \
--header 'api_access_token: <api-key>' \
--header 'Content-Type: application/json; charset=utf-8' \
--data-raw '{
    "inbox_id": 1,
    "contact_id": 123,
    "source_id": "ticket_12345",
    "status": "open",
    "initial_message": "I need help with my account",
    "template_message": "Ticket created. Our team will get back to you shortly.",
    "private_note": "Customer reported issue via external ticketing system. Ticket ID: 12345",
    "hidden_from_widget": false,
    "contact": {
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone_number": "+1234567890",
        "identifier": "user_ext_12345"
    },
    "additional_attributes": {
        "source": "ticketing_system",
        "ticket_id": "12345"
    },
    "custom_attributes": {
        "priority": "high",
        "category": "billing"
    }
}'

Response Example

201 - Example 1

{
    "id": 42,
    "inbox_id": 1,
    "contact_id": 123,
    "status": "open",
    "created_at": "2025-10-13T10:30:00Z",
    "message": "Conversation created successfully"
}

Modified at 2025-12-16 21:29:06

Agent Conversation Metrics

List all documents