Delete 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/removeAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Corpo da requisição
obrigatórioapplication/jsonidsstring<uuid>[]Contact ids to delete, up to 1000
mín. 1 itens · máx. 1000 itens
emailsstring<email>[]Contact email addresses to delete, up to 1000; matched case-insensitively
mín. 1 itens · máx. 1000 itens
erasebooleanAlso erase each address from email history, event payloads and API logs (GDPR/LGPD); by default the send log is kept
Respostas
200
The contacts that were deleted
dataRemoveContactResponse[]obrigatórioMostrar propriedadesOcultar propriedades
Array de
RemoveContactResponseobjectstringobrigatórioValores permitidos:
contactcontactstring<uuid>obrigatóriodeletedbooleanobrigatórioValores permitidos:
true401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório