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

Cancel a broadcast

POST/broadcasts/{id}/cancel
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
idstring<uuid>requis
Réponses
200

Broadcast canceled

objectstringrequis
Valeurs autorisées :broadcast
idstring<uuid>requis
canceled_remainingintegerrequis

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

400

Not queued

statusCodenumberrequis
namestringrequis
messagestringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Requête
curl -X POST 'https://api.billionsend.com/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Réponse
{
  "object": "broadcast",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "canceled_remaining": 0
}

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