Forward a thread email
Forwards the email from the inbox address, quoted under “––––– Forwarded message ———” with its From, Date, Subject and To, after an optional note. Its attachments go along, with any attachments you add, within 10 MiB in all. An email that carries malware is never forwarded. Accepts an Idempotency-Key; a forward the inbox’s rules hold answers 202 with the Draft.
/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/forwardAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
inbox_idstringrequiredThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>requiredemail_idstring<uuid>requiredIdempotency-Keystring1 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.
application/jsontostring | string[]requiredAn address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringccstring | string[]An address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringbccstring | string[]An address or a list of them; "Name <address>" works too
Show propertiesHide properties
stringstringstringhtmlstringHTML body
textstringPlain-text body
subjectstring1-2000 characters on one line; defaults to the thread subject with Re: or Fwd:
attachmentsobject[] | nullFiles with base64 content (no remote paths), 10 MiB decoded in all; none on the shared domain. A held send keeps them with its draft
Show propertiesHide properties
objectfilenamestring | boolean | nullShow propertiesHide properties
stringbooleannullcontentstringcontent_typestringcontent_idstringInline part: the HTML shows it with <img src="cid:<content_id>">
pathstringrequires_approvalbooleanBillionSend extension: hold the email as a draft that a person approves (202 with the Draft)
headersanyNot supported yet: only an empty value is accepted, anything else answers 422
Sent
idstring<uuid>requiredThe ID of the sent email: GET /emails/{id} reads it
thread_idstring<uuid> | nullrequiredBillionSend extension: the thread the email was sent in
Held for approval
objectstringrequiredinbox_draftidstring<uuid>requiredtypestringrequiredstandalonereplytostring[] | nullrequiredccstring[]requiredbccstring[]requiredsubjectstring | nullrequiredhtmlstring | nullrequiredtextstring | nullrequiredthread_idstring<uuid> | nullrequiredreply_to_email_idstring<uuid> | nullrequiredemail_idstring<uuid> | nullrequiredcreated_atstringrequiredupdated_atstringrequiredattachmentsobject[]requiredThe draft's files, by position; empty once it is sent, rejected or expired
Show propertiesHide properties
objectidstringrequiredfilenamestringrequiredcontent_typestringrequiredsizeintegerrequiredstatusstringrequireddraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]requiredforwardbooleanrequireddecided_bystring | nullrequireddecided_atstring | nullrequiredexpires_atstring | nullrequiredsend_atstring | nullrequiredBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullrequiredBillionSend 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
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequiredRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumberrequirednamestringrequiredmessagestringrequiredNot found
statusCodenumberrequirednamestringrequiredmessagestringrequiredIdempotency conflict, or a draft already sent
statusCodenumberrequirednamestringrequiredmessagestringrequiredValidation error
statusCodenumberrequirednamestringrequiredmessagestringrequiredThe 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)
statusCodenumberrequirednamestringrequiredmessagestringrequired