Create up to 100 field forget requests in one call

Submit up to 100 field forget requests in a single call. Each item is judged and processed independently: a malformed item is rejected without blocking its siblings, and an item identical to a request still pending or in_progress and less than 24 hours old is reported as duplicate and returns that existing request's id, rather than creating a new one.

This always returns 202, even when every item was rejected, so check each item's result field rather than the HTTP status. For each accepted or duplicate item, poll GET /field-forget/{id} with its id to find out how the request completed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

requests: a non-empty list, capped at 100, of the same profile_hash/fields objects POST /field-forget accepts.

A batch of field forget request submissions.

requests
array of objects
required
length between 1 and 100

A non-empty list, capped at 100 items, of profile_hash/fields objects, each with the same shape POST /field-forget accepts.

requests*

Field forget request submission. Identifies one profile by its profile_hash and names the field(s) to erase.

string
required
^[0-9a-f]+-[0-9a-f]{6}-[0-9a-f]{8,}$

The profile hash of the profile to act on, as returned by GET /profiles/.

fields
array of strings
required
length ≥ 1

The field(s) to erase: email, phone, or both. Order does not matter and duplicates are ignored; the request is stored and returned with the fields sorted alphabetically.

fields*
Allowed:

A field that can be forgotten. This list is the set supported by the service and is kept in sync via the service's own spec test.

Responses

403

API key is not authorised to access this resource.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json