Update Page Metadata

PUT

Update Page-level metadata, including SEO and Open Graph fields.

Required scope | pages:write

Path parameters

page_idstringRequired

Unique identifier for a Page

Query parameters

localestringOptional

Unique identifier for a specific locale. Applicable, when using localization.

Request

This endpoint expects an object.
titlestringOptional

Title of the Page

slugstringOptional

slug of the Page (derived from title)

seoobjectOptional

SEO-related fields for the Page

openGraphobjectOptional

Open Graph fields for the Page

Response

Request was successful

idstring

Unique identifier for the Page

siteIdstringOptional

Unique identifier for the Site

titlestringOptional

Title of the Page

slugstringOptional

slug of the Page (derived from title)

parentIdstringOptional

Identifier of the parent folder

collectionIdstringOptional

Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection.

createdOndatetimeOptional

The date the Page was created

lastUpdateddatetimeOptional

The date the Page was most recently updated

archivedbooleanOptional

Whether the Page has been archived

draftbooleanOptional

Whether the Page is a draft

canBranchbooleanOptional

Indicates whether the Page supports Page Branching

isBranchbooleanOptional

Indicates whether the Page is a Branch of another Page Page Branching

isMembersOnlybooleanOptional

Indicates whether the Page is restricted by Memberships Controls

seoobjectOptional

SEO-related fields for the Page

openGraphobjectOptional

Open Graph fields for the Page

localeIdstringOptional

Unique ID of the page locale

publishedPathstringOptional

Relative path of the published page URL

Errors