Reply in a thread
Replies from the inbox address in the thread, with In-Reply-To and References set: to the email’s Reply-To or sender (or, for an email the inbox sent, its recipients), plus everyone else on it with reply_all. Bcc is never copied. Takes attachments as POST /emails does. Accepts an Idempotency-Key. When the inbox’s rules hold the reply (or requires_approval is true) it is kept as a draft for a person to approve and the answer is 202 with the Draft.
/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/replyAuthorizationToken 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/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)
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