Skip to main content
POST
cURL
Guide: Receiving email

Authorizations

Authorization
string
header
required

Authorization: Bearer . An application key (tk_live_, tk_test_) has full access, which covers every product and any product added later, or custom access, chosen when the key is created: one or more of the scopes verify:check, verify:send (includes verify:check), notifications:read, notifications:send (includes notifications:read), email:read, email:send (includes email:read), email:manage (includes email:send), webhooks:manage, email:inbound, notifications:templates (includes notifications:read), chat:menus, chat:attendant. No key made on the API keys page holds notifications:templates, full access included: the three template writes answer such a key 403 insufficient_scope. A connected app's key holds it. Nor chat:menus: the five conversation menu operations answer such a key 403 insufficient_scope, and a connected app's key holds it once the client approved it. Nor chat:attendant: the five auto-attendant operations answer such a key 403 insufficient_scope too, and a connected app's key holds it once the client approved it. email:manage and webhooks:manage are held only by a key someone chose them for: a full-access key, old or new, never holds them. email:inbound, which reads, deletes and forwards received e-mail, is opt-in on every key, full access included: a key holds it only when it was turned on when the key was created. A call outside the key's access answers 403 insufficient_scope and names the scope it needs in the WWW-Authenticate response header. A partner key (tk_partner_) always has full access. Whatever its access, a key is a server-side secret.

Headers

Idempotency-Key
string

As on a send: the same key answers the first forward again.

Path Parameters

id
string<uuid>
required

Body

application/json
to
string
required

1 to 10 addresses (one may be a string).

from
object

An address on a verified domain of the application, or {name, address}. By default the address's forward-from on its domain, else the first verified domain's default sender.

note
string

At most 2000 characters, placed as one paragraph above the original.

Response

Forwarded

id
string
status
string
from
object
to
string[]
cc
(string | null)[]
bcc
(string | null)[]
reply_to
string[]
subject
string
reference
string | null
tags
(string | null)[]
scheduled_at
string | null
recipients
object[]
price_halalas
integer
cost
object
created_at
string<date-time>
mode
string