Patch version

patch

https://api.cms.optimizely.com/preview3/experimental/content/{key}/versions/{version}

Patch an existing content item. If a content item with the provided key does not exist an error is returned. This API is experimental and may change in future releases.

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 that should be patched.

Query Params

locale

string

The locale of the content that should be patched.

Body Params

The content information that should be patched.

properties

object

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

displayName

string

required

length between 1 and 255

The display name of this content item.

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.

status

string

enum

The status of this version of the content item.

Allowed:

delayPublishUntil

date-time | null

Indicates a time when this content version should transition to published status. Must only be assigned when Status is set to Scheduled.

container

string | null

The key that identifies the container content that this content item belongs to.

owner

string | null

The key that identifies the owner of this content. Content that is own by another content is also known as an asset.

routeSegment

string | null

A string that represents the segment that should be used when routing or generate routes to the current content instance.

lastModified

date-time

composition

object

Specifies a node in a content composition.

Headers

cms-skip-validation

boolean

Indicates that the content validation should be ignored.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

403Forbidden

404Not Found