PUT /pages/{page_id}

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

Required scope | pages:write

Servers

Path parameters

Name Type Required Description
page_id String Yes

Unique identifier for a Page

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
localeId String No

Unique identifier for a specific Locale.

Learn more about localization.

Request body fields

Name Type Required Description
openGraph Object No

Open Graph fields for the Page

openGraph.description String No

The description supplied to Open Graph annotations

openGraph.title String No

The title supplied to Open Graph annotations

openGraph.descriptionCopied Boolean No

Indicates the Open Graph description was copied from the SEO description

openGraph.titleCopied Boolean No

Indicates the Open Graph title was copied from the SEO title

seo Object No

SEO-related fields for the Page

seo.description String No

The Page description shown in search engine results

seo.title String No

The Page title shown in search engine results

slug String No

Slug for the page.

Note: The slug field is ignored in the following cases — all other fields in the same request still apply:

  • The site's home page, collection template pages, and utility pages (e.g. 404, password, search).
  • For secondary locales, updating the slug requires an Advanced or Enterprise localization add-on plan.
title String No

Title for the page

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.