Update Template Metadata
update_template_metadataUpdate a stored template version's name, comment, category, tags, deployment time, expiry, or parent template so Carbone renders and manages the correct version.
Instructions
Update the metadata of ONE stored template version: name, comment, category, tags, deployment (deployedAt), scheduled deletion (expireAt), or the Template ID it belongs to (moveToTemplateId). With a Template ID, Carbone patches its currently deployed version only; with a Version ID, that exact version. Use deployedAt to choose the version used when rendering by Template ID. Returns the patched versionId and the updated fields, as echoed back by Carbone. To delete a template now, use delete_template.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | DEPRECATED: the 1.6.0 name of moveToTemplateId, kept so existing callers keep working. Use moveToTemplateId; passing both with different values is rejected. | |
| name | No | New display name, max 200 characters. | |
| tags | No | New list of tags, replacing the existing ones. Duplicates are removed and the list is sorted; the whole list is limited to 100 characters (about 8 tags of 9 characters). | |
| comment | No | New free-text comment, max 200 characters. | |
| category | No | New category, max 200 characters. | |
| expireAt | No | Schedule deletion of the patched version at a UTC Unix timestamp (seconds). After that time it is no longer listed, downloadable or renderable (404), and the file is purged after the retention delay. Send 0 to cancel a scheduled deletion (permanent again); omit to leave it unchanged. To delete now, use delete_template. | |
| deployedAt | No | Unix timestamp (seconds) to set as the deployment time for this version. Carbone picks the version with the most recent deployedAt when rendering by Template ID. Use 42000000000 to deploy immediately (special "NOW" value). Future values are not allowed, and the deployed version's deployedAt cannot move back in time. | |
| templateId | Yes | Template ID (64-bit) or Version ID (SHA-256) of the version to update. A Template ID patches only its currently deployed version (not every version). A Version ID patches that exact version. | |
| moveToTemplateId | No | CAUTION, structural change: moves the patched version to this other Template ID (64-bit; a Version ID is rejected). It is NOT the template to patch (that is templateId). Pass the version's Version ID as templateId; with a Template ID, its currently deployed version is moved and that Template ID falls back to its next most recent version (or stops resolving if none is left). Fails if the move creates a deployedAt conflict at the destination. Only use it when the user asks to move a version. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Template ID the version now belongs to (returned when moveToTemplateId was used). | |
| name | No | Name, returned if updated. | |
| tags | No | Tags, returned if updated. | |
| comment | No | Comment, returned if updated. | |
| category | No | Category, returned if updated. | |
| expireAt | No | Deletion timestamp (0 = never expires), returned if updated. | |
| versionId | Yes | Version ID of the patched version. | |
| deployedAt | No | Deployment timestamp, returned if updated. |