Skip to navigation

Update Item Sitemap Setting

Updates the sitemap setting of one item. It doesn’t change the item’s field data.

Publish to apply changes

Updates apply to the staged version of the item. Publishing an item updates its live setting, but the sitemap.xml file changes only after you publish the site.

Beta access
These endpoints are available only to workspaces in the sitemap indexing beta. Valid requests from other workspaces return 404.
Enterprise Only
This endpoint requires an Enterprise workspace.

Required scope | cms:write

Authentication

AuthorizationBearer

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

Path parameters

collection_idstringRequiredformat: "objectid"
Unique identifier for a Collection
item_idstringRequiredformat: "objectid"
Unique identifier for an Item

Request

This endpoint expects an object.
includeInSitemapbooleanRequired

Set to true to list the item’s page in the sitemap, or false to leave it out.

cmsLocaleIdstringOptionalformat: "objectid"
Unique identifier for the CMS locale to update. Omit this field to update the item in the site's primary locale.

Response

Request was successful
idstringformat: "objectid"
Unique identifier for the item
slugstring
The item's slug
namestring
The item's name
includeInSitemapboolean

Whether Webflow lists the item’s page in the site’s auto-generated sitemap.xml file. Archived items, and draft items that were never published, are left out whatever this value is. This setting has no effect when Auto-generate sitemap is turned off.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error