Update metadata for a site.

put

https://example.com/authoring/v1/sites/{site-id}

Update the metadata for an existing site. A default site with ID 'default' exists out-of-the-box.

The update data must include the rev and name metadata fields.

User roles: admin, manager, editor

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

site-id

uuid

required

The ID of the site.

Query Params

forceOverride

boolean

Force update of the existing site metadata without requiring the current rev value.
When set to true this request will overwrite the stored site metadata regardless of a difference in revisions.

Body Params

Provide the updated site metadata in the body of the request. The current revision (rev) and the site name (name) fields must be provided in order to update the site metadata.

Updating Site Metadata

string

The ID of the site.

rev

string

The current revision of the document. This is a required field.

name

string

The name of the site. This is a required field.

routingMode

string

The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'. With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.

Responses

200Success, returns updated site

400Bad request

401Unauthorized

403Forbidden

409Conflict

429Too Many Requests

defaultUnexpected error