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

Update a draft

Each given field replaces the stored one; null clears it. Setting html or text replaces the whole body: the part left out becomes null. attachments replaces the whole list (null or an empty list removes the files). A sent draft, or one that changed during the request, answers 409. An edit by an agent sends a draft waiting for approval back to draft. send_at (BillionSend extension) schedules the draft to be sent as the caller, or reschedules it, and clears send_error; null cancels the schedule. A draft waiting for approval cannot be scheduled (409). When the scheduled send goes out, the draft becomes sent; when the inbox’s rules hold it, pending_approval; when it is refused (the key revoked, the inbox deleted, a limit reached), it stays a draft with send_at null, send_error set and an inbox.draft.send_failed webhook.

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

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

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

draft_idstring<uuid>必填
请求体
application/json
tostring | string[] | null

An address or a list of them; "Name <address>" works too

显示属性
任意项:
string
string
string[]
string 数组
string
null
null
ccstring | string[] | null

An address or a list of them; "Name <address>" works too

显示属性
任意项:
string
string
string[]
string 数组
string
null
null
bccstring | string[] | null

An address or a list of them; "Name <address>" works too

显示属性
任意项:
string
string
string[]
string 数组
string
null
null
subjectstring | null
htmlstring | null
textstring | null
attachmentsobject[] | null

Files with base64 content (no remote paths), 10 MiB decoded in all; none on the shared domain. A held send keeps them with its draft

显示属性
object 数组
filenamestring | boolean | null
显示属性
任意项:
string
string
boolean
boolean
null
null
contentstring
content_typestring
content_idstring

Inline part: the HTML shows it with <img src="cid:<content_id>">

最小长度 1 · 最大长度 255
pathstring
send_atstring | null

BillionSend extension: send the draft at this time, as the caller, within 30 days: an ISO 8601 datetime with offset (e.g. "2026-09-01T12:00:00Z") or a relative time like "in 2 hours". A past time sends it within a minute; null cancels. The send runs every rule and limit then; a refused one leaves the draft unsent with send_error set and fires inbox.draft.send_failed. A draft waiting for approval cannot be scheduled (409)

响应
200

Draft

objectstring必填
允许值:inbox_draft
idstring<uuid>必填
typestring必填
允许值:standalonereply
tostring[] | null必填
ccstring[]必填
bccstring[]必填
subjectstring | null必填
htmlstring | null必填
textstring | null必填
thread_idstring<uuid> | null必填
reply_to_email_idstring<uuid> | null必填
email_idstring<uuid> | null必填
created_atstring必填
updated_atstring必填
attachmentsobject[]必填

The draft's files, by position; empty once it is sent, rejected or expired

显示属性
object 数组
idstring必填
filenamestring必填
content_typestring必填
sizeinteger必填
statusstring必填
允许值:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]必填
forwardboolean必填
decided_bystring | null必填
decided_atstring | null必填
expires_atstring | null必填
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必填
试一试
服务器
授权
参数
请求体application/json
请求
curl -X PATCH 'https://api.billionsend.com/inboxes/string/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "string",
  "cc": "string",
  "bcc": "string",
  "subject": "string",
  "html": "string",
  "text": "string",
  "attachments": [
    {
      "filename": "string",
      "content": "string",
      "content_type": "string",
      "content_id": "string",
      "path": "string"
    }
  ],
  "send_at": "string"
}'
响应
{
  "object": "inbox_draft",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "type": "standalone",
  "to": [
    "string"
  ],
  "cc": [
    "string"
  ],
  "bcc": [
    "string"
  ],
  "subject": "string",
  "html": "string",
  "text": "string",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  "reply_to_email_id": "5e00f13a-4994-422b-8a76-6ae8ac072852",
  "email_id": "8e6bf5ae-e456-4654-87f8-33e2156caffc",
  "created_at": "string",
  "updated_at": "string",
  "attachments": [
    {
      "id": "string",
      "filename": "string",
      "content_type": "string",
      "size": 0
    }
  ],
  "status": "draft",
  "approval_reasons": [
    "string"
  ],
  "forward": true,
  "decided_by": "string",
  "decided_at": "string",
  "expires_at": "string",
  "send_at": "string",
  "send_error": "string"
}

这个页面有帮助吗?