Skip to main content
POST
Open a ticket

Authorizations

Authorization
string
header
required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Body

application/json
conversation_id
string

Required on creation: the ticket follows the contact of this conversation and the agent of its channel

subject
string

Required on creation

Maximum string length: 255
description
string | null
Maximum string length: 10000
status
string

Status code of the agent; on creation, its first open status by default. A resolved or terminal status resolves or closes the ticket, an open one reopens it.

Example:

"in_progress"

priority
string | null

SLA policy code of the agent: sets the due dates; null removes it

Example:

"high"

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false