Skip to main content
POST
Criar uma retenção legal

Autorizações

Authorization
string
header
obrigatório

nia_sk_...

Cabeçalhos

Idempotency-Key
string
obrigatório

Obrigatório. Guardado por 24 horas com o hash do corpo: a mesma chave com o mesmo corpo devolve a primeira resposta, e a mesma chave com outro corpo devolve 409 conflict.

Required string length: 1 - 256

Corpo

application/json

Exatamente um de handle, object ou conversation_id: o que fica fora do expurgo enquanto a retenção está ativa.

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

Um identificador de um sujeito num canal ou sistema: um telefone, um e-mail, um id do CRM.

object
ObjectRef · object | null

Um objeto de negócio num sistema de registro.

Resposta

A retenção.

created_at
string<date-time>
obrigatório
hold_id
string
obrigatório
Required string length: 1 - 512
scope
enum<string>
obrigatório
Opções disponíveis:
handle,
object,
conversation
status
enum<string>
obrigatório
Opções disponíveis:
active,
released
released_at
string<date-time> | null