v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Update Page

Update an existing Page of a Site.

put/sites/multiscreen/{site_name}/pages/{page_uuid}

Path parameters

site_namestring required

The unique identifier of the target Site.

page_uuidstring required

The name of the target page.

Request body

draft_status'STAGED_DRAFT' | 'DRAFT'

If marked as STAGED_DRAFT, the page will be published alongside the next publish of the site. If DRAFT, then the page will not be published and a currently published page will be unpublished. You cannot set the home page as draft.

header_htmlstring

The new page header HTML to assign to the page.

pathstring

The new url path to assign to the page.

titlestring

The new title to assign to the page.

Response

200

draft_statusstring

header_htmlstring

pathstring

titlestring

typestring

uuidstring

Example response

{
  "draft_status": "DRAFT",
  "header_html": "<script>console.log('woo')</script>",
  "path": "about/abab",
  "seo": {
    "description": "My page description",
    "og_image": "https://example.org/path/to/image.png",
    "title": "About Page"
  },
  "title": "ABOUT",
  "type": "REGULAR",
  "uuid": "string"
}