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

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.

receipt_hash
string | null

Hex SHA-256 of the erasure receipt.