Skip to main content
POST
Create a legal hold

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

Exactly one of handle, object or conversation_id: what is kept from purging while the hold is active.

reason
string
required
Required string length: 1 - 500
conversation_id
string | null
Required string length: 1 - 512
handle
Handle · object | null

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

object
ObjectRef · object | null

A business object in a system of record, e.g. invoice / erp / 0823.

Response

The hold.

created_at
string<date-time>
required
hold_id
string
required
Required string length: 1 - 512
scope
enum<string>
required
Available options:
handle,
object,
conversation
status
enum<string>
required
Available options:
active,
released
released_at
string<date-time> | null