Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Delete a contact from an audience

DELETE/audiences/{audienceId}/contacts/{id}
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
audienceIdstring<uuid>erforderlich
idstringerforderlich
min. Länge 1
Query-Parameter
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

Erlaubt:truefalse
Antworten
200

Contact deleted

objectstringerforderlich
Erlaubt:contact
contactstring<uuid>erforderlich
deletedbooleanerforderlich
Erlaubt:true
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X DELETE 'https://api.billionsend.com/audiences/497f6eca-6276-4993-bfeb-53cbbbba6f08/contacts/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "contact",
  "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
  "deleted": true
}

War diese Seite hilfreich?