Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Path Parameters

list_id
string
required

ID of the list. String UUIDv4 value.

Body

application/json

Request body for removing records from a list.

A match that finds no record is reported as not_in_list. A match that is not valid for the list's object fails the request with HTTP 400. When two records resolve to the same record, the later one is reported as not_in_list.

records
object[]
required

Records to remove, at most 100 per request. Each record must appear only once in the request.

Required array length: 1 - 100 elements

Identifies a record to add to or remove from a list, either by ID or by match criteria. Both forms can be mixed in one request.

Response

Response for a remove request. Returned with HTTP 200 whenever the request itself was valid; inspect summary and each item's status for per-record outcomes.

Response for a remove request. Returned with HTTP 200 whenever the request itself was valid; inspect summary and each item's status for per-record outcomes.

status
enum<string>
required
Available options:
success
data
object[]
required

One result per requested record, in request order.

The record was removed from the list.

summary
object
required

Counts of remove outcomes by status. total equals the number of records in the request and the sum of the other counts.