Actions11
Update a Template
AI-generatedSummary
Update an existing template by specifying the template ID and providing new values for its properties such as name, description, dimensions, and content layers. Optionally replace all layers or selectively update specified layers or pages within the template.
Inputs
- Template (required) — The template to update, selectable from a list or by specifying its template ID (UUID).
- Replace All Layers — Boolean flag to determine if all existing layers should be replaced (true) or only specified layers updated (false, default).
- Update Fields — Collection of fields to update for the template, including name, description, width, height, layers (JSON array of layer objects), and pages (JSON array for multi-page templates).
Output shape
a single updated template record returned as JSON from the API
If 'Replace All Layers' is true, layers not included in the request are removed; otherwise, only specified layers are updated. Input layers and pages should be valid JSON structures. The operation issues a PUT request to /v1/template/{templateId} to perform the update. Error handling depends on API response.
Examples
Example 1: Update the name and dimensions of a template by specifying its ID, without altering layers.
Provide the 'templateId', set 'Replace All Layers' to false or leave default, and in 'Update Fields' set the new name, width, and height.
Example 2: Replace all layers of a template with new layer content.
Set 'Replace All Layers' to true and provide the new 'layers' JSON array in 'Update Fields'. This will remove existing layers not present in the new array.