update_publication

mutationSince v1.0

Change a publication's name, slug, description, homepage, site map, per-type rendering selection, connected report services, or whether readers see auto-IDs.

The site map, rendering selection and report services each replace the whole list rather than being added to it. Read the current one with list_publications first and send it back with your change included, or you will drop the entries you left out. Applied immediately.

Parameters

Name	Type	Required	Description
`publication`	`String`	✓	The publication to change, by ID or name.
`set_nav`	`Array<Object>`	—	Replacement site map. This replaces the whole list rather than adding to it — read the current one with list_publications and send it back with your change included, or the trees you left out are dropped.
`set_slug`	`String`	—	New path segment for the publication's URL. Changing it changes every published link.
`set_homepage`	`String`	—	Replacement front page document. Replaces the existing homepage completely.
`set_description`	`String`	—	New author note for the publication.
`set_external_services`	`Array<Object>`	—	Replacement list of connected report services. Replaces the whole list, so include the ones you want to keep.
`set_show_auto_ids`	`Boolean`	—	Whether readers see elements' auto-IDs across every reading surface — navigation tree, section indexes, page titles, and what the reading assistant may quote.
`set_name`	`String`	—	New display name for the publication.
`set_rendering_selection`	`Array<Object>`	—	Replacement choice of which rendering presents each type. Replaces the whole list, so include the selections you want to keep.

Example Request

{"publication": "Service Handbook", "set_show_auto_ids": false, "set_rendering_selection": [{"target_type_id": "nt-uuid", "rendering_id": "7c31..."}]}

Example Response

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