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

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.

POST/emails/receiving/{id}/forward
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
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
erforderlichapplication/json
tostring | string[]erforderlich

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

Eigenschaften anzeigen
Mindestens eines von:
string
string
string[]
Array von string
string
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
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
requires_approvalboolean

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

fromstring

Sender 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

modestring

inline (default) quotes the original under the note; attachment sends it as forwarded_message.eml

Erlaubt:inlineattachment
Antworten
200

Sent

objectstringerforderlich
Erlaubt:email
idstring<uuid>erforderlich
thread_idstring<uuid> | nullerforderlich
inbox_idstring<uuid> | nullerforderlich
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/emails/receiving/497f6eca-6276-4993-bfeb-53cbbbba6f08/forward' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "to": "string",
  "cc": "string",
  "bcc": "string",
  "html": "string",
  "text": "string",
  "subject": "string",
  "attachments": [
    {
      "filename": "string",
      "content": "string",
      "content_type": "string",
      "content_id": "string",
      "path": "string"
    }
  ],
  "requires_approval": true,
  "from": "string",
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2",
  "mode": "inline"
}'
Antwort
{
  "object": "email",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "thread_id": "1de43264-67cb-48af-89f9-e865c375bb84",
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2"
}

War diese Seite hilfreich?