Delete contacts in bulk

Delete a set of contacts, or every contact on the accessible lists. This is the v3 equivalent of the v1 contact_delete_list action.

Send either ids or deleteAll, never both. listids optionally restricts which list relations the delete may touch, as the v1 listids parameter did; without it every list the caller can access is used. v1's _all sentinel in ids is not accepted, use "deleteAll": true instead.

The delete is not transactional: contacts are removed one at a time, so a run can partially succeed. deleted lists the ids removed and failed the ids that were not, each with a reason. When the account's billing-period delete limit stops the run, the response is a 422 with pastlimit: 1 and deleted still lists the contacts removed before the limit was hit.

With deleteAll, the id list is a snapshot: a contact that is already gone when its turn comes is skipped rather than reported as a failure.

Requires permission to delete contacts.

Body Params
ids
array of int32s

Ids of the contacts to delete. Positive integers, and mutually exclusive with deleteAll.

ids
boolean

Set to true to delete every contact on the lists the delete applies to. Only true is accepted, and it is mutually exclusive with ids.

listids
array of int32s

Restrict the delete to these list relations. Must be a non-empty array of positive integers when given; defaults to every list the caller can access.

listids
Responses

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