Record an unsubscribe
/unsubscribesAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
application/jsonemailstring<email>requisBare email address that opted out; stored normalized (lowercase)
domain_idstring<uuid> | nullOne of your domains: the address stops receiving marketing mail from it. Omitted or null: from every domain of the team
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>requisemailstringrequisThe address; a tombstone for a recipient erased under GDPR/LGPD
domain_idstring<uuid> | nullrequisThe domain the opt-out is for; null for the whole team, or once that domain was deleted
domainstring | nullrequisThe 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_atstringrequisobjectstringrequisunsubscribeMissing, malformed, unknown or revoked API key
statusCodenumberrequisnamestringrequismessagestringrequisA key held to one domain recorded an opt-out for another domain or for the whole team
statusCodenumberrequisnamestringrequismessagestringrequisValidation error, or a domain_id that is not one of your domains
statusCodenumberrequisnamestringrequismessagestringrequisOver the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequisnamestringrequismessagestringrequis