Sitecore API catalog/Pages API/
/
Rename a page

Rename a page

Request

Changes the name of a page.

Security
Bearer
Path
pageIdstringrequired

The page identifier.

Example:8f0b81bc-7388-46be-b109-6e73d1114470
Query
environmentIdstring

The identifier of the environment.

Example:environmentId=main
Body

Input data containing properties of the page

newNamestring, non-emptyrequired

The new name for the page. Example value: About Us

Example:"About Us"
curl -i -X POST \
  'https://xmapps-api.sitecorecloud.io/api/v1/pages/8f0b81bc-7388-46be-b109-6e73d1114470/rename?environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "newName": "About Us"
  }'

Responses

Success

Bodyapplication/json
pageIdstring or null

The page identifier. Example value: 8f0b81bc-7388-46be-b109-6e73d1114470

Example:"8f0b81bc-7388-46be-b109-6e73d1114470"
namestring or null

The system name of the page. Example value: Home

Example:"Home"
displayNamestring or null

The display name of the page. Example value: Site Home

Example:"Site Home"
pathstring or null

The path of the page. Example value: /sitecore/content/collection01/site01/Home/about

Example:"/sitecore/content/collection01/site01/Home/about"
Response
{
  "pageId": "8f0b81bc-7388-46be-b109-6e73d1114470",
  "name": "Home",
  "displayName": "Site Home",
  "path": "/sitecore/content/collection01/site01/Home/about"
}