Skip to main content
POST
Preview a canvas template

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Template to preview

templateId
string
required

Template ID from GET /api/v0/canvas/templates

companyId
string

Company that owns brandKitId

format
string

Named canvas format (same values as POST /api/v0/canvas, e.g. 'square', 'portrait', 'story', 'landscape'); default 'portrait'. Ignored when width/height are given.

width
integer

Custom width in px; requires height

height
integer

Custom height in px; requires width

brandKitId
string

Brand kit whose colors and logo to preview with; defaults to the company's default brand kit

colorPalette
object

Unsaved palette {primary, secondary, accent, background, surface, text} as #RRGGBB; overrides the brand kit palette

Response

Canvas HTML with sample content

html
string

Complete canvas HTML filled with sample content

width
integer
height
integer