Skip to main content
POST
Initiate human takeover

Authorizations

Authorization
string
header
required

Server-side tenant-scoped credential created from Build > API Keys.

Headers

Idempotency-Key
string
required

Reuse only with the exact original request. If the outcome is uncertain, reconcile the returned requestId before retrying.

Required string length: 1 - 200

Body

application/json
conversationId
string
required
Required string length: 1 - 200
title
string
required
Required string length: 1 - 160
description
string
Maximum string length: 800
propertyId
string
Required string length: 1 - 200

Response

Confirmed resource state.

ticketId
string
required
tenantId
string
required
conversationId
string
required
type
enum<string>
required
Available options:
ticket,
escalation
status
enum<string>
required
Available options:
pending,
in_progress,
resolved,
cancelled
title
string
required
description
string
required
revision
integer
required
Required range: x >= 0
channel
string
required
contextStatus
enum<string>
required
Available options:
available,
unavailable
contact
object
required
createdAt
string
required
updatedAt
string
required
source
object
required
permittedActions
enum<string>[]
required
Available options:
update,
assign,
note,
start,
resolve,
cancel
business
object
assignee
object
resolvedAt
string
escalation
object