Skip to main content
POST
Refresh a canvas 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

Path Parameters

sessionId
string
required
Required string length: 1 - 200

Response

The same scoped session with a new bootstrap credential.

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