Pages and ComponentsPages

Update Page Metadata

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

Note: When updating Page Metadata in secondary locales, you may only add slug to the request if your Site has the Advanced or Enterprise Localization add-on.

Required scope | pages:write

Path parameters

page_idstringRequiredformat: "objectid"

Unique identifier for a Page

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

localeIdstringOptional

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

Request

This endpoint expects an object.
idstringRequiredformat: "objectid"

Unique identifier for the Page

siteIdstringOptionalformat: "objectid"

Unique identifier for the Site

titlestringOptional

Title of the Page

slugstringOptional

slug of the Page (derived from title)

parentIdstringOptionalformat: "objectid"

Identifier of the parent folder

collectionIdstringOptionalformat: "objectid"

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

createdOnstringOptionalformat: "date-time"

The date the Page was created

lastUpdatedstringOptionalformat: "date-time"

The date the Page was most recently updated

archivedbooleanOptionalDefaults to false

Whether the Page has been archived

draftbooleanOptionalDefaults to false

Whether the Page is a draft

canBranchbooleanOptionalDefaults to false

Indicates whether the Page supports Page Branching

isBranchbooleanOptionalDefaults to false

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

seoobjectOptional

SEO-related fields for the Page

openGraphobjectOptional

Open Graph fields for the Page

localeIdstringOptionalformat: "objectid"

Unique ID of the page locale

publishedPathstringOptional

Relative path of the published page URL

Response

Request was successful

idstringformat: "objectid"

Unique identifier for the Page

siteIdstringOptionalformat: "objectid"

Unique identifier for the Site

titlestringOptional

Title of the Page

slugstringOptional

slug of the Page (derived from title)

parentIdstringOptionalformat: "objectid"

Identifier of the parent folder

collectionIdstringOptionalformat: "objectid"

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

createdOnstringOptionalformat: "date-time"

The date the Page was created

lastUpdatedstringOptionalformat: "date-time"

The date the Page was most recently updated

archivedbooleanOptionalDefaults to false

Whether the Page has been archived

draftbooleanOptionalDefaults to false

Whether the Page is a draft

canBranchbooleanOptionalDefaults to false

Indicates whether the Page supports Page Branching. Pages that are already branches cannot be branched again.

isBranchbooleanOptionalDefaults to false

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

branchIdstringOptionalformat: "objectid"

If the Page is a Branch of another Page, this is the ID of the Branch

seoobjectOptional

SEO-related fields for the Page

openGraphobjectOptional

Open Graph fields for the Page

localeIdstringOptionalformat: "objectid"

Unique ID of the page locale

publishedPathstringOptional

Relative path of the published page URL

Errors