Patch version

patch

https://example.com/_cms/v1/content/{key}/versions/{version}

Patch an existing content item and returns the updated content item. If a content item with the provided key does not exist an error is returned.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

The key of the content item that should be patched.

version

string

required

The version of the content item that should be patched.

Body Params

The content information that should be patched.

Base structure for content data. Contains properties defined by the content type and optional bindings to source content. Property values must conform to the types defined in the associated ContentType definition.

binding

object

Associates a content item with another source content item, establishing a relationship defined by a content type binding. Used for linking managed content to external or reference content.

properties

object | null

Properties as they are defined by corresponding component or content type.

displayName

string | null

The display name of this content version.

published

date-time | null

Indicates a time when this content was published or should be published.

expired

date-time | null

Indicates a time when this content expired or should expire.

routeSegment

string | null

A string that represents the segment that should be used when routing or generating routes to the current content instance. This value will always be null when content is based on a non-routable content type.

simpleRoute

string | null

^[^/].*$

A simple route (shortcut URL) used to access pages and experiences.

composition

object

Specifies a node in a content composition.

media

object

Represents media data attached to a content item.

Headers

cms-skip-validation

array of strings

Indicates which content validation rules should be bypassed. Supported values are '*' (skip all validations), 'data' (skip data validation), and 'references' (skip reference validation). Values can be combined, empty or duplicated values are ignored, and any unknown values result in a validation error. Use with caution as this may allow creation of invalid content that could cause issues in production.

cms-skip-validation

Allowed:

Prefer

array of strings

Indicates client preference for the response content as per IETF RFC7240. Currently only supports 'return=representation' which can be used to indicate a preference to receive a representation of the resource that has been altered in the response.

Prefer

If-Match

string

If provided, the PATCH request will only be considered if the value matches the RFC7232 ETag of the current resource. Weak ETags will always be ignored.

If-Unmodified-Since

string

If provided, the PATCH request will only be considered if the resource has not been modified since the provided date. This parameter will be ignored if an 'If-Match' parameter is also provided.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

204

No Content

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found

412Precondition Failed

500Internal Server Error