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

Send a draft

Sends the draft from the inbox address; the body is optional and only ever holds headers, which are not supported (an empty value is fine), and an Idempotency-Key is accepted. Answers the sent email’s id. A draft waiting for approval goes out only when a person or a team-wide full access key sends it (403 approval_required otherwise), and their send skips the inbox’s rules but never the team’s limits or the shared domain’s rules. An agent’s send of a draft runs the rules and may hold it (202).

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

A BillionSend API key (bs_…).

路径参数
inbox_idstring必填

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

draft_idstring<uuid>必填
标头参数
Idempotency-Keystring

1 to 256 characters. A retry with the same key and the same body answers the original response instead of sending again; the same key with a different body answers 409 invalid_idempotent_request.

最小长度 1 · 最大长度 256
请求体
application/json
headersany

Not supported: only an empty value is accepted, anything else answers 422

响应
200

Sent

idstring<uuid>必填

The ID of the sent email: GET /emails/{id} reads it

thread_idstring<uuid> | null必填

BillionSend extension: the thread the email was sent in

202

Held for approval

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

400

Malformed JSON body

statusCodenumber必填
namestring必填
messagestring必填
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 POST 'https://api.billionsend.com/inboxes/string/drafts/497f6eca-6276-4993-bfeb-53cbbbba6f08/send' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "headers": null
}'
响应
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

这个页面有帮助吗?