Create Site

POST

Create a site.

Enterprise Only
This endpoint requires an Enterprise workspace.

Required scope | workspace:write

Path parameters

workspace_idstringRequired

Unique identifier for a Workspace

Request

This endpoint expects an object.
namestringRequired

The name of the site

templateNamestringOptional

The workspace or marketplace template to use

parentFolderIdstringOptional

MegaDodo Publications - Potential Book Ideas

Response

Request was successful

idstring

Unique identifier for the Site

workspaceIdstring

Unique identifier for the Workspace

createdOndatetime

Date the Site was created

displayNamestring

Name given to Site

shortNamestring

Slugified version of name

lastPublisheddatetime

Date the Site was last published

lastUpdateddatetime

Date the Site was last updated

previewUrlstring

URL of a generated image for the given Site

timeZonestring

Site timezone set under Site Settings

dataCollectionEnabledboolean

Indicates if data collection is enabled for the site.

dataCollectionTypeenum
Allowed values: alwaysoptOutdisabled

The type of data collection enabled for the site.

parentFolderIdstringOptional

The ID of the parent folder the Site exists in

customDomainslist of objectsOptional
localesobjectOptional

Errors

Built with