Skip to main content
POST
Takeover

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Session id (ses_<uuid>)

Body

application/json
reason
string | null

Free-text note recorded on the audit event ("clearing a captcha", a ticket id, …).

Response

Control taken

hold_expires_at
string
required

When the hold lapses unless released or renewed.

paused
boolean
required

true when a live agent task was actually interrupted.

session_id
string
required
task_id
string | null

The task the takeover acted on (task_<uuid>), when there was one.