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

Record an unsubscribe

POST/unsubscribes
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Request-Body
erforderlichapplication/json
emailstring<email>erforderlich

Bare email address that opted out; stored normalized (lowercase)

domain_idstring<uuid> | null

One of your domains: the address stops receiving marketing mail from it. Omitted or null: from every domain of the team

Antworten
200

The address now stops receiving marketing mail from the domain (domain_id) or from every domain of the team (domain_id omitted or null). Idempotent: an opt-out that already exists is returned as it is, with its original created_at.

idstring<uuid>erforderlich
emailstringerforderlich

The address; a tombstone for a recipient erased under GDPR/LGPD

domain_idstring<uuid> | nullerforderlich

The domain the opt-out is for; null for the whole team, or once that domain was deleted

domainstring | nullerforderlich

The domain's name; null for the whole team. A deleted domain's name stays, and its opt-outs apply again if the domain is added back

created_atstringerforderlich
objectstringerforderlich
Erlaubt:unsubscribe
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

A key held to one domain recorded an opt-out for another domain or for the whole team

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error, or a domain_id that is not one of your domains

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Bodyapplication/json
Anfrage
curl -X POST 'https://api.billionsend.com/unsubscribes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c"
}'
Antwort
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "domain": "string",
  "created_at": "string",
  "object": "unsubscribe"
}

War diese Seite hilfreich?