Replace a content item

Request

Fully replaces a content item. Fields omitted from the request are cleared.

Security

Bearer

Path

idstringrequired

The content item identifier.

Example:76036f5e-cbce-46d1-af0a-4143f9b557aa

Query

environmentIdstring

The environment identifier.

Example:environmentId=main

Body

required

The replacement input.

fieldsArray of objects(UpdateFieldValue)required

The complete set of field values for the content item. Fields present in the current item but omitted here are cleared (set to empty value). The service resolves each field's type from the content type before serialization.

namestring, non-emptyrequired

The content item name.

Example:"MyContentItem"

displayNamestring or null

The content item display name.

Example:"My Content Item"

languagestring or null

The content item language.

Example:"en"

curl -i -X PUT \
  'https://edge-platform.sitecorecloud.io/authoring/api/v1/content-items/76036f5e-cbce-46d1-af0a-4143f9b557aa?environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "MyContentItem",
    "displayName": "My Content Item",
    "language": "en",
    "fields": [
      {
        "id": "75577384-3C97-45DA-A847-81B00500E25",
        "value": {
          "title": "sample title"
        }
      }
    ]
  }'

Responses

Successful operation

Bodyapplication/json

isFallbackboolean

Indicates whether any item-level fallback was used for the response.

Example:true

revisionstring or null

Unique revision identifier for the content item. Used as an optimistic concurrency guard during save or update operations. The value is updated whenever the item changes, allowing clients to verify that they are updating the latest revision.

Example:"37265ed7-85cf-4876-9c09-b6590fc6cf3a"

fieldsArray of objects or null(ComponentItemField)

The content item fields.

idstring or null

The content item identifier.

Example:"37265ed7-85cf-4876-9c09-b6590fc6cf3a"

namestring or null

The content item name.

Example:"My content item"

displayNamestring or null

The content item display name.

Example:"My content item"

languagestring or null

The content item language.

Example:"en"

versioninteger, (int32)

The content item version.

Example:1

templateIdstring or null

The template identifier.

Example:"97265ed7-85cf-4876-9c09-b6590fc6cf3a"

pathstring or null

The content item path.

Example:"/sitecore/content/Home"

permissionsobject(Permissions)

The access rights of the current user to the site.

systemobject(System)

Response

{
  "isFallback": true,
  "revision": "37265ed7-85cf-4876-9c09-b6590fc6cf3a",
  "fields": [
    { … }
  ],
  "id": "37265ed7-85cf-4876-9c09-b6590fc6cf3a",
  "name": "My content item",
  "displayName": "My content item",
  "language": "en",
  "version": 1,
  "templateId": "97265ed7-85cf-4876-9c09-b6590fc6cf3a",
  "path": "/sitecore/content/Home",
  "permissions": {
    "canAdmin": true,
    "canWrite": true,
    "canCreate": true,
    "canDelete": true,
    "canRename": true,
    "canRead": true,
    "canPublish": true,
    "canDuplicate": true,
    "canWriteLanguage": true
  },
  "system": {
    "created": "2024-01-15T10:30:00Z",
    "createdBy": "sitecore admin",
    "updated": "2024-01-15T10:30:00Z",
    "updatedBy": "sitecore admin"
  }
}