跳到内容
Esc
↑↓导航↵打开⌘J预览

List drafts

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

GET/inboxes/{inbox_id}/drafts
授权
AuthorizationBearer 令牌 · header必填

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

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

查询参数
limitinteger

Page size, 1-100 (default 20)

最小值 1 · 最大值 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.

响应
200

Drafts

objectstring必填
允许值:list
has_moreboolean必填
dataobject[]必填
显示属性
object 数组
idstring<uuid>必填
typestring必填
允许值:standalonereply
tostring[] | null必填
ccstring[]必填
bccstring[]必填
subjectstring | null必填
snippetstring | null必填
thread_idstring<uuid> | null必填
reply_to_email_idstring<uuid> | null必填
updated_atstring必填
attachmentsobject[]必填
显示属性
object 数组
idstring必填
filenamestring必填
content_typestring必填
sizeinteger必填
statusstring必填
允许值:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]必填
send_atstring | null必填

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

send_errorstring | null必填

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

statusCodenumber必填
namestring必填
messagestring必填
403

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

statusCodenumber必填
namestring必填
messagestring必填
404

Not found

statusCodenumber必填
namestring必填
messagestring必填
409

Idempotency conflict, or a draft already sent

statusCodenumber必填
namestring必填
messagestring必填
422

Validation error

statusCodenumber必填
namestring必填
messagestring必填
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)

statusCodenumber必填
namestring必填
messagestring必填
试一试
服务器
授权
参数
请求
curl -X GET 'https://api.billionsend.com/inboxes/string/drafts' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
响应
{
  "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"
    }
  ]
}

这个页面有帮助吗?