Pular para o conteúdo principal
POST
Apagar

Autorizações

Authorization
string
header
obrigatório

nia_sk_...

Cabeçalhos

Idempotency-Key
string
obrigatório

Obrigatório. Fica guardado 24 horas com o hash do corpo; a mesma chave com outro corpo devolve 409.

Required string length: 1 - 256

Corpo

application/json

Passe exatamente um entre profile_id, handle e conversation_id.

target
enum<string>
obrigatório
Opções disponíveis:
profile,
handle,
conversation
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.

profile_id
string<uuid> | null
purpose
string | null

Uma oposição a uma finalidade em vez de um apagamento: as linhas do cliente colhidas só para ela são apagadas, as outras mantêm as demais finalidades, e o que for gravado depois a deixa de fora. Alvo perfil ou handle; a resposta é final (completed). A finalidade precisa estar declarada no documento purposes do espaço.

Pattern: ^[a-z][a-z0-9_.:-]{0,63}$

Resposta

Aceito. O apagamento entra na fila; status vai de pending para running e completed.

request_id
string
obrigatório
requested_at
string<date-time>
obrigatório
status
enum<string>
obrigatório
Opções disponíveis:
pending,
running,
completed,
failed
target_id
string
obrigatório

Id do perfil, do handle ou da conversa; nunca o valor do handle.

target_kind
enum<string>
obrigatório
Opções disponíveis:
profile,
handle,
conversation
completed_at
string<date-time> | null
erased
Erased · object

Linhas apagadas por tabela.

export_run_ids
string[]

Execuções da exportação contínua que já levavam linhas apagadas.

object_bound_rows_erased
integer
padrão:0

Das linhas apagadas, as que tratam de um objeto de negócio: o que a pessoa disse sobre um processo, um pedido, uma fatura, que foi junto com ela.

objects
string[]

Os objetos de que essas linhas tratavam, como type:namespace:id, no máximo 100: a empresa registra de novo, no sistema dela, o que precisar deles.

receipt_hash
string | null

SHA-256, em hexadecimal, do comprovante de apagamento.

retained
Retained · object

O que ficou, por classe: registros de turno que uma retenção legal mantém até a liberação (held_turn_conversations), e o que uma obrigação legal mantém (review_requests, legal_holds).