Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Cancel a broadcast

POST/broadcasts/{id}/cancel
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstring<uuid>obrigatório
Respostas
200

Broadcast canceled

objectstringobrigatório
Valores permitidos:broadcast
idstring<uuid>obrigatório
canceled_remainingintegerobrigatório

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

400

Not queued

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Requisição
curl -X POST 'https://api.billionsend.com/broadcasts/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "broadcast",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "canceled_remaining": 0
}

Esta página foi útil?