Variable Settings
The Variable section at the top of the Properties panel is where you configure a bound element’s variable. The fields vary slightly by element type.
Text variable settings
Section titled “Text variable settings”Select a variable-bound text element. The Variable section shows the Name and Required settings; Label, Description, Allowed values and the API Preview are in its collapsed Advanced sub-section.
| Field | Description |
|---|---|
| Name | The variable identifier — shown on the element’s {{...}} badge and used as the field name in CSV columns and the API (e.g. discount_code). Must be unique within the template. Validated in real time. |
| Default | There’s no separate field: the element’s Text Content (in the Text section) is the default. It’s shown on the canvas and used when the variable is not provided at render time. |
| Required | Switch on or off (on by default). Required variables must be provided in every render request; optional variables fall back to the default. |
| Label | A human-readable display name shown in the Generate dialog and API docs (e.g. “Discount Code”). |
| Description | Optional help text for API consumers or teammates. |
| Allowed values | Optional list of accepted values. Leave it empty to accept any text; when set, a batch row whose value isn’t on the list is rejected before rendering. |
| API Preview | A read-only snippet showing how to send this variable in a request’s variables object. |
Image variable settings
Section titled “Image variable settings”| Field | Description |
|---|---|
| Name | Variable identifier (e.g. employee_photo) |
| Default URL | Fallback image when no value is provided. Leave it empty to use the image placed on the canvas (shown under the field as Using the canvas image, with a copy button for its reference). |
| API Preview | Snippet showing how to send this variable |
There’s no Required switch for an image variable: it’s required only when neither a Default URL nor a canvas image is set (“No default: callers must provide this image.”).
How the supplied image fills its box (Cover, Contain, Fill) is set in the image’s Appearance section, like any other image. See Images.
QR code variable settings
Section titled “QR code variable settings”| Field | Description |
|---|---|
| Name | Variable identifier (e.g. redemption_url) |
| Default | Default QR data/URL used in previews and when no value is provided |
| Label | Human-readable label (e.g. “Redemption URL”) |
| API Preview | Snippet showing how to send this variable |
Barcode variable settings
Section titled “Barcode variable settings”| Field | Description |
|---|---|
| Name | Variable identifier (e.g. product_sku) |
| Default | Default barcode data, used when no value is provided |
| Label | Human-readable label (e.g. “Product SKU”) |
| API Preview | Snippet showing how to send this variable |
Variable naming rules
Section titled “Variable naming rules”- Start with a lowercase letter; use lowercase letters, numbers, and underscores only; at most 50 characters.
- Must be unique within a template.
- Examples:
first_name,qr_code_data,promo_image. - Avoid spaces or special characters.
The Variables panel
Section titled “The Variables panel”All variables in a template are listed in the Variables panel (left sidebar rail, variable icon). Each entry shows the variable name, type icon, and Required/Optional badge. Click a row to select that element on the canvas. An API Request Preview at the bottom shows the variables object for the whole template.