Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

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ório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstringobrigatório
comprimento mín. 1
Parâmetros de consulta
erasestring

BillionSend 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:truefalse
Respostas
200

Contact deleted

objectstringobrigatório
Valores permitidos:contact
contactstring<uuid>obrigatório
deletedbooleanobrigatório
Valores permitidos:true
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X DELETE 'https://api.billionsend.com/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "contact",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "deleted": true
}

Esta página foi útil?