Forward an email
BillionSend extension: forwards server-side, inline under a note (default) or with the original attached as forwarded_message.eml (mode: attachment), within 10 MiB. An email that carries malware is never forwarded. Sender rules and the 202 draft answer are those of the reply. Accepts an Idempotency-Key. Needs a full access key.
/emails/receiving/{id}/forwardAuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
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)
fromstringSender on a verified team domain; defaults to the inbox address the email reached, else the first address it was received for
inbox_idstring<uuid>The inbox to answer from, among those the email reached
modestringinline (default) quotes the original under the note; attachment sends it as forwarded_message.eml
inlineattachmentSent
objectstringrequiredemailidstring<uuid>requiredthread_idstring<uuid> | nullrequiredinbox_idstring<uuid> | nullrequiredHeld 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