How can we help you?

Create or Update a Template

Product: FeraRender Topic: Template Management Versions: Applies to all documented versions Current

Create a new template or update an existing template through the template service.

Audience: Template managers and developers
Recommended visibility: Public

Overview

Create a new template or update an existing template through the template service. Template-management changes can affect every application that renders by template name or UUID. Make changes in a controlled environment and keep a source copy of production templates.

Key points

  • Provide a unique name and valid owner context.
  • Set category, caption, output, and content intentionally.
  • Use mode FULL for a self-contained package and COMPOSITE for assembled templates.
  • Changing content invalidates a previously compiled package.
  • Treat create-or-update behavior as an upsert by owner and name.

Example

curl --request POST "<render-base-url>/api/v1/templates" \
  --header "x-auth-token: <token>" \
  --header "instance: <instance-uuid>" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "Client Welcome Letter",
    "caption": "Client Welcome Letter",
    "category": "Letters",
    "output": "DOC",
    "mode": "FULL",
    "content": "<root version=\"1\">...</root>"
  }' 

Replace bracketed values with values issued for the target environment. Never place production tokens, API keys, or client data in screenshots or public examples.

Recommended procedure

  1. Open or retrieve the intended tenant-owned template.
  2. Review its mode, output, resources, and compilation status.
  3. Make the smallest necessary change and save it.
  4. Validate, compile when required, and perform a sample render before use.

Troubleshooting

A saved template no longer renders

Check whether the edit made a composite template STALE and compile it again.

An imported template has a different name

The importer creates a unique tenant name when a collision exists.

A resource does not appear

Confirm the resource name, encoding, template UUID, and whether the downstream renderer supports that resource type.

Related documentation


Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.