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}/forwardAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
inbox_idstringobrigatórioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obrigatórioemail_idstring<uuid>obrigatórioIdempotency-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[]obrigatórioAn address or a list of them; "Name <address>" works too
Mostrar propriedadesOcultar propriedades
stringstringstringccstring | string[]An address or a list of them; "Name <address>" works too
Mostrar propriedadesOcultar propriedades
stringstringstringbccstring | string[]An address or a list of them; "Name <address>" works too
Mostrar propriedadesOcultar propriedades
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 propriedadesOcultar propriedades
objectfilenamestring | boolean | nullMostrar propriedadesOcultar propriedades
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>obrigatórioThe ID of the sent email: GET /emails/{id} reads it
thread_idstring<uuid> | nullobrigatórioBillionSend extension: the thread the email was sent in
Held for approval
objectstringobrigatórioinbox_draftidstring<uuid>obrigatóriotypestringobrigatóriostandalonereplytostring[] | nullobrigatórioccstring[]obrigatóriobccstring[]obrigatóriosubjectstring | nullobrigatóriohtmlstring | nullobrigatóriotextstring | nullobrigatóriothread_idstring<uuid> | nullobrigatórioreply_to_email_idstring<uuid> | nullobrigatórioemail_idstring<uuid> | nullobrigatóriocreated_atstringobrigatórioupdated_atstringobrigatórioattachmentsobject[]obrigatórioThe draft's files, by position; empty once it is sent, rejected or expired
Mostrar propriedadesOcultar propriedades
objectidstringobrigatóriofilenamestringobrigatóriocontent_typestringobrigatóriosizeintegerobrigatóriostatusstringobrigatóriodraftpending_approvalsentrejectedexpiredapproval_reasonsstring[]obrigatórioforwardbooleanobrigatóriodecided_bystring | nullobrigatóriodecided_atstring | nullobrigatórioexpires_atstring | nullobrigatóriosend_atstring | nullobrigatórioBillionSend extension: when the scheduled send goes out; null when not scheduled
send_errorstring | nullobrigatórioBillionSend 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
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioRestricted API key, the inbox's or the shared domain's rules, or held mail
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioNot found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioIdempotency conflict, or a draft already sent
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioValidation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatórioThe 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)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório