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

Cancel a broadcast

POST/broadcasts/{id}/cancel
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
idstring<uuid>erforderlich
Antworten
200

Broadcast canceled

objectstringerforderlich
Erlaubt:broadcast
idstring<uuid>erforderlich
canceled_remainingintegererforderlich

Emails stopped before going out; the ones already sent are not recalled

400

Not queued

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
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 POST 'https://api.billionsend.com/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "broadcast",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "canceled_remaining": 0
}

War diese Seite hilfreich?