Key concepts

Template anatomy

A template is a multi-page design document authored in the studio. Each template has an id (shown in its studio URL and in every list/get response) — that's the :id path parameter used everywhere in the API.

Any text, image or color-fill layer on a page can be given a variableName. Doing so turns it into a parameter: a key you can override at render time instead of editing the design itself.

ParamTypeNotes
textstringOverrides the layer's displayed text.
imagestring (URL)Overrides the layer's image source.
colorstring (hex)Overrides a fill color.
A template's parameters are derived automatically by scanning its pages for named layers — there's no separate schema to author or keep in sync. Fetch them any time to see every key a given template accepts before rendering it.