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

Cancel an email

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

A BillionSend API key (bs_…).

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

Email canceled

objectstringobrigatório
Valores permitidos:email
idstring<uuid>obrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Not cancelable

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/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "email",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Esta página foi útil?