Update field values

Request

Updates values of existing fields for a specific 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 page field values

fieldsArray of objects, non-empty(PageField)required

The fields to update on the page.

versionNumberinteger or null, (int32)

The version number of the page to update. Example value: 2

Example:2

languagestring or null

The language of the page to update. Example value: en-US

Example:"en-US"

curl -i -X PATCH \
  'https://xmapps-api.sitecorecloud.io/api/v1/pages/8f0b81bc-7388-46be-b109-6e73d1114470?environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "versionNumber": 2,
    "language": "en-US",
    "fields": [
      {
        "name": "Title",
        "value": "Welcome to our site"
      }
    ]
  }'

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"
}