Skip to main content
POST
Create an authenticated email canvas embed session

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json
target
object
required
user
object
required
parentOrigin
string
required
Maximum string length: 2000
permissions
enum<string>[]
Required array length: 1 - 3 elements
Available options:
read,
edit,
presence

Response

A scoped session and single-use bootstrap credential.

sessionId
string
required
embedUrl
string<uri>
required
bootstrapToken
string
required
expiresAt
string<date-time>
required
target
object
required