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}/forwardAuthorizationJeton Bearer · headerrequisA BillionSend API key (bs_…).
idstring<uuid>requisIdempotency-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[]requisAn address or a list of them; "Name <address>" works too
Afficher les propriétésMasquer les propriétés
stringstringstringccstring | string[]An address or a list of them; "Name <address>" works too
Afficher les propriétésMasquer les propriétés
stringstringstringbccstring | string[]An address or a list of them; "Name <address>" works too
Afficher les propriétésMasquer les propriétés
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
Afficher les propriétésMasquer les propriétés
objectfilenamestring | boolean | nullAfficher les propriétésMasquer les propriétés
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
objectstringrequisemailidstring<uuid>requisthread_idstring<uuid> | nullrequisinbox_idstring<uuid> | nullrequisHeld for approval
objectstringrequisinbox_draftidstring<uuid>requistypestringrequisstandalonereplytostring[] | nullrequisccstring[]requisbccstring[]requissubjectstring | nullrequishtmlstring | nullrequistextstring | nullrequisthread_idstring<uuid> | nullrequisreply_to_email_idstring<uuid> | nullrequisemail_idstring<uuid> | nullrequiscreated_atstringrequisupdated_atstringrequisattachmentsobject[]requisThe draft's files, by position; empty once it is sent, rejected or expired
Afficher les propriétésMasquer les propriétés
objectidstringrequisfilenamestringrequiscontent_typestringrequissizeintegerrequisstatusstringrequisdraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]requisforwardbooleanrequisdecided_bystring | nullrequisdecided_atstring | nullrequisexpires_atstring | nullrequissend_atstring | nullrequisBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullrequisBillionSend 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
statusCodenumberrequisnamestringrequismessagestringrequisRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumberrequisnamestringrequismessagestringrequisNot found
statusCodenumberrequisnamestringrequismessagestringrequisIdempotency conflict, or a draft already sent
statusCodenumberrequisnamestringrequismessagestringrequisValidation error
statusCodenumberrequisnamestringrequismessagestringrequisThe 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)
statusCodenumberrequisnamestringrequismessagestringrequis