Define render parameters

To reuse a template with different data, first declare the fields it accepts. Parameters lets you name each field, choose its type, and provide a default value.

Start with a simple field, connect it to HTML, then open Payload to inspect the resulting data structure.

1. Add a field in Schema

Open Parameters, select Schema, and choose Add. Rename the new field to the name you want to use, such as recipient.

Color and Asset are prop-only types in the current editor, so they do not appear in the Parameters type list.

2. Set Default and Required

Enter Default on the field card to provide a value when the caller omits the field. The required control in the card header toggles the field’s Required status.

Use values of the declared type: a Number uses 2, and a Boolean uses true or false. The string "2" is not a number. An empty string is still a supplied value, not an omitted field.

Add a description to explain the value’s purpose, units, or expected format to someone using the template.

3. Connect the field to content

Each card includes an EMBED expression. For recipient, insert this into a section’s HTML:

<p>{{ params.recipient }}</p>

recipient must match the Schema name. If you rename the field later, update both the HTML expression and the data supplied to the template.

4. Get the structure from Payload

Switch to Payload to inspect the object built from the declared fields and defaults:

{
  "recipient": "Tembuilder",
  "copies": 2,
  "showNotes": true
}

This is the template’s data object. Use the same structure when entering data in Run. For API integration, the object belongs in the request’s parameters field; see the Render API reference for the request fields and endpoints.

For nested fields and lists, continue with Objects, arrays, and tables.