Delete contacts in bulk
Deletes up to 1000 contacts by id or by email address in one request and lists the rows actually deleted; unknown ids or addresses are skipped. Emails stay in the log; erase: true also scrubs each address from email history, event payloads and API logs, like DELETE /contacts/{id}?erase=true.
POST
/contacts/batch/removeAutorisierung
AuthorizationBearer-Token · headererforderlichA BillionSend API key (bs_…).
Request-Body
erforderlichapplication/jsonidsstring<uuid>[]Contact ids to delete, up to 1000
min. 1 Elemente · max. 1000 Elemente
emailsstring<email>[]Contact email addresses to delete, up to 1000; matched case-insensitively
min. 1 Elemente · max. 1000 Elemente
erasebooleanAlso erase each address from email history, event payloads and API logs (GDPR/LGPD); by default the send log is kept
Antworten
200
The contacts that were deleted
dataRemoveContactResponse[]erforderlichEigenschaften anzeigenEigenschaften ausblenden
Array von
RemoveContactResponseobjectstringerforderlichErlaubt:
contactcontactstring<uuid>erforderlichdeletedbooleanerforderlichErlaubt:
true401
Missing, malformed, unknown or revoked API key
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich422
Validation error
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumbererforderlichnamestringerforderlichmessagestringerforderlich