Update Page Metadata

PUT

https://api.webflow.com/v2/pages/:page_id

PUT

/v2/pages/:page_id

1 import datetime
2 
3 from webflow import PageOpenGraph, PageSeo, Webflow
4 
5 client = Webflow(
6     access_token="YOUR_ACCESS_TOKEN",
7 )
8 client.pages.update_page_settings(
9     page_id="63c720f9347c2139b248e552",
10     locale_id="65427cf400e02b306eaa04a0",
11     id="6596da6045e56dee495bcbba",
12     site_id="6258612d1ee792848f805dcf",
13     title="Guide to the Galaxy",
14     slug="guide-to-the-galaxy",
15     created_on=datetime.datetime.fromisoformat(
16         "2024-03-11 10:42:00+00:00",
17     ),
18     last_updated=datetime.datetime.fromisoformat(
19         "2024-03-11 10:42:42+00:00",
20     ),
21     archived=False,
22     draft=False,
23     can_branch=True,
24     is_branch=False,
25     seo=PageSeo(
26         title="The Ultimate Hitchhiker's Guide to the Galaxy",
27         description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.",
28     ),
29     open_graph=PageOpenGraph(
30         title="Explore the Cosmos with The Ultimate Guide",
31         title_copied=False,
32         description="Dive deep into the mysteries of the universe with your guide to everything galactic.",
33         description_copied=False,
34     ),
35     page_locale_id="653fd9af6a07fc9cfd7a5e57",
36     published_path="/en-us/guide-to-the-galaxy",
37 )

200pagesUpdatePageSettingsExample

1 {
2   "id": "6596da6045e56dee495bcbba",
3   "siteId": "6258612d1ee792848f805dcf",
4   "title": "Guide to the Galaxy",
5   "slug": "guide-to-the-galaxy",
6   "createdOn": "2024-03-11T10:42:00.000Z",
7   "lastUpdated": "2024-03-11T10:42:42.000Z",
8   "archived": false,
9   "draft": false,
10   "canBranch": true,
11   "isBranch": false,
12   "seo": {
13     "title": "The Ultimate Hitchhiker's Guide to the Galaxy",
14     "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels."
15   },
16   "openGraph": {
17     "title": "Explore the Cosmos with The Ultimate Guide",
18     "titleCopied": false,
19     "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.",
20     "descriptionCopied": false
21   },
22   "localeId": "653fd9af6a07fc9cfd7a5e57",
23   "publishedPath": "/en-us/guide-to-the-galaxy"
24 }

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

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

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

Errors