update_rendering

mutationSince v1.0

Change a rendering's name, description, or document. The new document replaces the old one entirely rather than being merged into it — send the whole template, not just the part you changed. Applied immediately.

Preview the result with preview_rendering afterwards: an edit that breaks a block shows up as missing content on the page, not as an error.

Parameters

Name	Type	Required	Description
`set_name`	`String`	—	New name for the rendering.
`rendering`	`String`	✓	The rendering to change, by ID or name.
`set_document`	`String`	—	Replacement page template. It replaces the existing document completely, so send the whole thing rather than just the part you changed. Same format as create_rendering's document — see "Writing Rendering Documents".
`locale`	`String`	—	Write the new name and description as this language's translation (for example 'de') rather than to the base text.
`set_description`	`String`	—	New author note for the rendering.

Example Request

{"rendering": "Service page", "set_document": "# {{ subject.label }}\n\n:::view{ source=roles heading=\"Roles involved\" }"}

Example Response

{"success": true, "operation_count": 1, "versions": [93]}