Delete a contact
Deletes the contact and its segment memberships. Its emails stay in the log; pass erase=true to also scrub the address from email history, event payloads and API logs.
DELETE
/contacts/{id}Autorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Parâmetros de caminho
idstringobrigatóriocomprimento mín. 1
Parâmetros de consulta
erasestringBillionSend extension. true also erases the address from email history, event payloads and API logs (a GDPR/LGPD erasure); by default the send log is kept and ages out with the team's retention window
Valores permitidos:
truefalseRespostas
200
Contact deleted
objectstringobrigatórioValores permitidos:
contactcontactstring<uuid>obrigatóriodeletedbooleanobrigatórioValores permitidos:
true401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório