Docmost Octri Preview
POST/templates/update

Update a template

Updates an existing template. Supply its UUID in templateId and include only the fields you want to change; omitted fields remain unchanged. You can update its content, description, icon, title, or space.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

The template fields to update. Only templateId is required; omitted fields remain unchanged.

contentobjectoptional
ProseMirror document JSON.
descriptionstringoptional
The updated template description, up to 2,000 characters.
iconstringoptional
The template's updated icon.
spaceIdstringoptional
Move the template to this space. Omit to leave it where it is.
templateIdstringrequired
The UUID of the template to update.
titlestringoptional
The updated template title, between 1 and 500 characters.

2 status codes
200Returns the updated template object.
dataobjectoptional
statusintegeroptional
successbooleanoptional
403Returned when the request is forbidden, the template is not found, or templates are not included in the current licence.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

templateId is required and must be a UUID. If provided, title must be between 1 and 500 characters and description must not exceed 2,000 characters. A 403 is returned when the request is forbidden, the template is not found, or templates are not included in the current licence.