Skip to main content
POST
Forget

Authorizations

Authorization
string
header
required

nia_sk_...

Headers

Idempotency-Key
string
required

Mandatory. Kept 24 hours with the body hash; the same key with a different body returns 409.

Required string length: 1 - 256

Body

application/json

What to forget. Handles travel only in the body, never in a URL.

target
enum<string>
required
Available options:
profile,
handle,
conversation
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.

profile_id
string<uuid> | null
purpose
string | null

An objection to one purpose instead of an erasure: the customer's rows collected only for it are deleted, the others keep their other purposes, and what is written later leaves it out. A profile or handle target; the answer is final (completed). The purpose must be declared in the space's purposes document.

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

Response

Accepted. The erasure is queued; status moves from pending to running and completed.

request_id
string
required
requested_at
string<date-time>
required
status
enum<string>
required
Available options:
pending,
running,
completed,
failed
target_id
string
required

Profile id, handle id or conversation id; never the handle value.

target_kind
enum<string>
required
Available options:
profile,
handle,
conversation
completed_at
string<date-time> | null
erased
Erased · object

Rows erased per table.

export_run_ids
string[]

Continuous export runs that already carried erased rows.

object_bound_rows_erased
integer
default:0

Of the rows erased, those about a business object: what the person said about a case, an order, an invoice, which went with them.

objects
string[]

The objects those rows were about, as type:namespace:id, at most 100: the company records again, in its own system, what it needs of them.

receipt_hash
string | null

Hex SHA-256 of the erasure receipt.

retained
Retained · object

What stayed, by class: turn records a legal hold keeps until its release (held_turn_conversations), and what a legal obligation keeps (review_requests, legal_holds).