Skip to main content
POST
Create a handoff

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required

Required. Kept 24 hours with the hash of the body: a retry with the same key returns the first answer, and the same key with a different body returns 409 conflict.

Required string length: 1 - 256

Body

application/json

Hands the subject to target. The package is compiled at level, the verification the receiving side has of the subject, so it never carries what that side could not read.

subject
Handle · object
required

An identifier of a subject in some channel or system: a phone, an e-mail, a CRM id.

target
string
required
Required string length: 1 - 256
agent
string | null

The agent handing off; the calling key's name when absent.

Required string length: 1 - 256
conversation_id
string | null
Required string length: 1 - 512
expected_by
string<date-time> | null

When the outcome is due; the space's default wait when absent.

level
enum<string>
default:V0

Session verification levels. no_customer sits outside the V0-V4 scale.

Available options:
V0,
V1,
V2,
V3,
V4,
no_customer
reason
string | null
Required string length: 1 - 500

Response

The handoff, with its package.

created_at
string<date-time>
required
handoff_id
string
required
Required string length: 1 - 512
status
enum<string>
required
Available options:
created,
accepted,
closed,
expired
expected_by
string<date-time> | null
outcome
string | null
Required string length: 1 - 256
package
HandoffPackage · object | null

What a handoff carries to whoever receives it (the coordination spec, 7).