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

List drafts

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

GET/inboxes/{inbox_id}/drafts
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

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

Query-Parameter
limitinteger

Page size, 1-100 (default 20)

min. 1 · max. 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.

Antworten
200

Drafts

objectstringerforderlich
Erlaubt:list
has_morebooleanerforderlich
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
typestringerforderlich
Erlaubt:standalonereply
tostring[] | nullerforderlich
ccstring[]erforderlich
bccstring[]erforderlich
subjectstring | nullerforderlich
snippetstring | nullerforderlich
thread_idstring<uuid> | nullerforderlich
reply_to_email_idstring<uuid> | nullerforderlich
updated_atstringerforderlich
attachmentsobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstringerforderlich
filenamestringerforderlich
content_typestringerforderlich
sizeintegererforderlich
statusstringerforderlich
Erlaubt:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]erforderlich
send_atstring | nullerforderlich

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

send_errorstring | nullerforderlich

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
409

Idempotency conflict, or a draft already sent

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
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)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/inboxes/string/drafts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "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"
    }
  ]
}

War diese Seite hilfreich?