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

List drafts

Unsent drafts (draft and pending_approval), most recently updated first; after pages toward older ones.

GET/inboxes/{inbox_id}/drafts
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
inbox_idstringobrigatório

The inbox ID or its email address, such as support@example.com

Parâmetros de consulta
limitinteger

Page size, 1-100 (default 20)

mín. 1 · máx. 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

Respostas
200

Drafts

objectstringobrigatório
Valores permitidos:list
has_morebooleanobrigatório
dataobject[]obrigatório
Mostrar propriedades
Array de object
idstring<uuid>obrigatório
typestringobrigatório
Valores permitidos:standalonereply
tostring[] | nullobrigatório
ccstring[]obrigatório
bccstring[]obrigatório
subjectstring | nullobrigatório
snippetstring | nullobrigatório
thread_idstring<uuid> | nullobrigatório
reply_to_email_idstring<uuid> | nullobrigatório
updated_atstringobrigatório
attachmentsobject[]obrigatório
Mostrar propriedades
Array de object
idstringobrigatório
filenamestringobrigatório
content_typestringobrigatório
sizeintegerobrigatório
statusstringobrigatório
Valores permitidos:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]obrigatório
send_atstring | nullobrigatório

BillionSend extension: when the scheduled send goes out; null when not scheduled

send_errorstring | nullobrigatório

BillionSend extension: the error name of the last scheduled send that was refused (e.g. invalid_api_key, inbox_send_cap_reached, not_found); null otherwise

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

Restricted API key, the inbox's or the shared domain's rules, or held mail

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
409

Idempotency conflict, or a draft already sent

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

The inbox's daily send limit, or the team's daily limit for mail from the shared domain, or 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 GET 'https://api.billionsend.com/inboxes/string/drafts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "has_more": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "standalone",
      "to": [
        "string"
      ],
      "cc": [
        "string"
      ],
      "bcc": [
        "string"
      ],
      "subject": "string",
      "snippet": "string",
      "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
      "reply_to_email_id": "5e00f13a-4994-422b-8a76-6ae8ac072852",
      "updated_at": "string",
      "attachments": [
        {
          "id": "string",
          "filename": "string",
          "content_type": "string",
          "size": 0
        }
      ],
      "status": "draft",
      "approval_reasons": [
        "string"
      ],
      "send_at": "string",
      "send_error": "string"
    }
  ]
}

Esta página foi útil?