Skip to main content
POST
Create conversation

Authorizations

Authorization
string
header
required

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

Path Parameters

userId
string
required

Body

application/json
message
string
required

The customer's first message.

title
string
attributes
object

Ticket attributes (data attributes); agent-only when the attribute's shared visibility is disabled.

source
string

Free-form source tag, e.g. "abb-mobile".

tags
string[]
attachments
object[]
workflowId
string

Start this workflow immediately (wf_… or bare id). Mutually exclusive with agentId.

agentId
string

Engage this AI agent directly. Mutually exclusive with workflowId.

Response

201 - application/json

Created

id
string
required
closed
boolean
required
archived
boolean
required
unread
boolean
required
workflowActive
boolean
required
number
number<double>
title
string
type
string
status
string
workflowId
string
assignee
object | null
attributes
object

Construct a type with a set of properties K of type T

contact
object
latestMessage
object
createdAt
string<date-time>
lastActivityAt
string<date-time>