Reply to an email
BillionSend extension: replies server-side, threaded with In-Reply-To and References. It goes out from the inbox the email reached (inbox_id picks one), else from the first address it was received for, or from from. A reply from an inbox runs its rules and may be held as a draft (202). Accepts an Idempotency-Key. Needs a full access key.
/emails/receiving/{id}/replyAuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
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/jsonhtmlstringHTML 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>">
pathstringccstring | 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
stringstringstringreply_allbooleanAlso copy the message's other recipients (cc), never its bcc
requires_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
Sent
objectstringobrigatórioemailidstring<uuid>obrigatóriothread_idstring<uuid> | nullobrigatórioinbox_idstring<uuid> | nullobrigatórioHeld 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