Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Create a new site

Use this endpoint to create a new site.

The new site can either be an initial draft site which has no associated ready version or it can be a draft of an existing ready site.

The body of the request should contain the metadata for the new site. This metadata should include the site 'name', 'linkedDocId' is optional, 'id' is optional. If 'linkedDocId' is provided, then the site created will be a draft of the ready site specified in 'linkedDocId'. If 'linkedDocId' is not provided, then the site created will be an initial draft site i.e no ready version exists yet. If ID is provided, and a draft of the default site is being created it must start with default. 'linkedDocId' must be set to 'default'. <br />User roles: admin, manager, editor

post/authoring/v1/sites

Query parameters

copySourceSiteIdstring

If ‘copySourceSiteId’ is specified when creating a site then a new site is created and all the pages from the source site are copied into the new site.

Request body

idstring

The ID of the site. If creating a draft of the default site the id must start with default.

linkedDocIdstring

The linkedDocId for draft sites. This is an optional field, if provided specify the ID of the ready site to create a draft of.

namestring

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

statusstring

The status of the site metadata (i.e. draft)

routingModestring

The is routingMode 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.

Response

succcess.

idstring

The ID of the site.

revstring

The current revision of the document.

namestring

The name of the site.

classificationstring

This is always site

lastModifiedstring

The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

lastModifierIdstring

This is the user id of the user that modified the site metadata. This field is read only

createdstring

The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only

creatorIdstring

This is the user id of the user that created the site metadata. This field is read only.

routingModestring

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.