Delete contacts of a list in batches

Delete a batch of the contacts on a list. Intended for emptying a very large list, which cannot be done in a single call, by repeating this request until it reports that it removed no more contacts.

Only contacts that belong to no other list are removed, so a contact subscribed elsewhere stays in the account. The list itself is not deleted; use DELETE /lists/{id} for that.

limit is required and caps how many contacts a single call removes.

This endpoint is gated: an account it is not enabled for receives 400 with You do not have permission to execute this.

Path Params
int32
required

id of the list whose contacts are being deleted

Query Params
int32
required

Maximum number of contacts to delete in this call. Must be 1 or greater.

Responses

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