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}/forwardAuthorizationToken Bearer · headerobligatorioA BillionSend API key (bs_…).
idstring<uuid>obligatorioIdempotency-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[]obligatorioAn address or a list of them; "Name <address>" works too
Mostrar propiedadesOcultar propiedades
stringstringstringccstring | string[]An address or a list of them; "Name <address>" works too
Mostrar propiedadesOcultar propiedades
stringstringstringbccstring | string[]An address or a list of them; "Name <address>" works too
Mostrar propiedadesOcultar propiedades
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
Mostrar propiedadesOcultar propiedades
objectfilenamestring | boolean | nullMostrar propiedadesOcultar propiedades
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
objectstringobligatorioemailidstring<uuid>obligatoriothread_idstring<uuid> | nullobligatorioinbox_idstring<uuid> | nullobligatorioHeld for approval
objectstringobligatorioinbox_draftidstring<uuid>obligatoriotypestringobligatoriostandalonereplytostring[] | nullobligatorioccstring[]obligatoriobccstring[]obligatoriosubjectstring | nullobligatoriohtmlstring | nullobligatoriotextstring | nullobligatoriothread_idstring<uuid> | nullobligatorioreply_to_email_idstring<uuid> | nullobligatorioemail_idstring<uuid> | nullobligatoriocreated_atstringobligatorioupdated_atstringobligatorioattachmentsobject[]obligatorioThe draft's files, by position; empty once it is sent, rejected or expired
Mostrar propiedadesOcultar propiedades
objectidstringobligatoriofilenamestringobligatoriocontent_typestringobligatoriosizeintegerobligatoriostatusstringobligatoriodraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]obligatorioforwardbooleanobligatoriodecided_bystring | nullobligatoriodecided_atstring | nullobligatorioexpires_atstring | nullobligatoriosend_atstring | nullobligatorioBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullobligatorioBillionSend 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
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioNot found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioIdempotency conflict, or a draft already sent
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioValidation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorioThe 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)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio