Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

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.

POST/inboxes/{inbox_id}/threads/{thread_id}/emails/{email_id}/reply
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
inbox_idstringerforderlich

The inbox ID or its email address, such as support@example.com

thread_idstring<uuid>erforderlich
email_idstring<uuid>erforderlich
Header-Parameter
Idempotency-Keystring

1 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.

min. Länge 1 · max. Länge 256
Request-Body
application/json
htmlstring

HTML body

textstring

Plain-text body

subjectstring

1-2000 characters on one line; defaults to the thread subject with Re: or Fwd:

attachmentsobject[] | null

Files with base64 content (no remote paths), 10 MiB decoded in all; none on the shared domain. A held send keeps them with its draft

Eigenschaften anzeigen
Array von object
filenamestring | boolean | null
Eigenschaften anzeigen
Mindestens eines von:
string
string
boolean
boolean
null
null
contentstring
content_typestring
content_idstring

Inline part: the HTML shows it with <img src="cid:<content_id>">

min. Länge 1 · max. Länge 255
pathstring
ccstring | string[]

An address or a list of them; "Name <address>" works too

Eigenschaften anzeigen
Mindestens eines von:
string
string
string[]
Array von string
string
bccstring | string[]

An address or a list of them; "Name <address>" works too

Eigenschaften anzeigen
Mindestens eines von:
string
string
string[]
Array von string
string
reply_allboolean

Also copy the message's other recipients (cc), never its bcc

requires_approvalboolean

BillionSend extension: hold the email as a draft that a person approves (202 with the Draft)

headersany

Not supported: only an empty value is accepted, anything else answers 422

Antworten
200

Sent

idstring<uuid>erforderlich

The ID of the sent email: GET /emails/{id} reads it

thread_idstring<uuid> | nullerforderlich

BillionSend extension: the thread the email was sent in

202

Held for approval

objectstringerforderlich
Erlaubt:inbox_draft
idstring<uuid>erforderlich
typestringerforderlich
Erlaubt:standalonereply
tostring[] | nullerforderlich
ccstring[]erforderlich
bccstring[]erforderlich
subjectstring | nullerforderlich
htmlstring | nullerforderlich
textstring | nullerforderlich
thread_idstring<uuid> | nullerforderlich
reply_to_email_idstring<uuid> | nullerforderlich
email_idstring<uuid> | nullerforderlich
created_atstringerforderlich
updated_atstringerforderlich
attachmentsobject[]erforderlich

The draft's files, by position; empty once it is sent, rejected or expired

Eigenschaften anzeigen
Array von object
idstringerforderlich
filenamestringerforderlich
content_typestringerforderlich
sizeintegererforderlich
statusstringerforderlich
Erlaubt:draftpending_approvalsentrejectedexpired
approval_reasonsstring[]erforderlich
forwardbooleanerforderlich
decided_bystring | nullerforderlich
decided_atstring | nullerforderlich
expires_atstring | nullerforderlich
send_atstring | nullerforderlich

BillionSend extension: when the scheduled send goes out; null when not scheduled

send_errorstring | nullerforderlich

BillionSend 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

401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
403

Restricted API key, the inbox's or the shared domain's rules, or held mail

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
409

Idempotency conflict, or a draft already sent

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

The 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)

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://api.billionsend.com/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/emails/497f6eca-6276-4993-bfeb-53cbbbba6f08/reply' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "html": "string",
  "text": "string",
  "subject": "string",
  "attachments": [
    {
      "filename": "string",
      "content": "string",
      "content_type": "string",
      "content_id": "string",
      "path": "string"
    }
  ],
  "cc": "string",
  "bcc": "string",
  "reply_all": true,
  "requires_approval": true,
  "headers": null
}'
Antwort
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84"
}

War diese Seite hilfreich?