Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
idstringobligatorio
longitud 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
Respuestas
200

Contact deleted

objectstringobligatorio
Valores permitidos:contact
contactstring<uuid>obligatorio
deletedbooleanobligatorio
Valores permitidos:true
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Solicitud
curl -X DELETE 'https://api.billionsend.com/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Respuesta
{
  "object": "contact",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "deleted": true
}

¿Te ha resultado útil esta página?