Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Delete contacts 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/remove
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Corps de la requête
requisapplication/json
idsstring<uuid>[]

Contact ids to delete, up to 1000

min 1 éléments · max 1000 éléments
emailsstring<email>[]

Contact email addresses to delete, up to 1000; matched case-insensitively

min 1 éléments · max 1000 éléments
eraseboolean

Also erase each address from email history, event payloads and API logs (GDPR/LGPD); by default the send log is kept

Réponses
200

The contacts that were deleted

dataRemoveContactResponse[]requis
Afficher les propriétés
Tableau de RemoveContactResponse
objectstringrequis
Valeurs autorisées :contact
contactstring<uuid>requis
deletedbooleanrequis
Valeurs autorisées :true
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/contacts/batch/remove' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "emails": [
    "user@example.com"
  ],
  "erase": true
}'
Réponse
{
  "data": [
    {
      "object": "contact",
      "contact": "ad596931-5d7c-4d2b-907e-5b64c9432eb4",
      "deleted": true
    }
  ]
}

Cette page vous a-t-elle été utile ?