--- title: Create version slug: cms-saas/api/create-version docTags: createdAt: 2026-08-28T15:28:05.479Z --- { "id": "a0RH_slG4knipZatS4oe-", "type": "api-oas-v2", "data": { "method": "POST", "url": "https://api.cms.optimizely.com/v1/content/{key}/versions", "servers": [ { "url": "https://api.cms.optimizely.com/v1/content/{key}/versions", "description": "Optimizely CMS API" } ], "name": "Create version", "description": "Create a new version of a content item.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "key", "type": "string", "description": "The key of the content item for which a new content version should be created." } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" }, { "kind": "optional", "name": "cms-skip-validation", "type": "array", "example": "*", "examples": [ { "label": "Skip all validations", "value": "*" }, { "label": "Skip data validation", "value": "data" }, { "label": "Skip reference validation", "value": "references" }, { "label": "Skip data and reference validation", "value": "data, references" } ], "description": "

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.

", "schema": [], "itemType": "string", "customType": "string[]" }, { "kind": "optional", "name": "Prefer", "type": "array", "example": "[\"return=representation\"]", "description": "

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.

", "schema": [], "itemType": "string", "customType": "string[]" } ], "queryParameters": [], "bodyDataParameters": [ { "kind": "required", "name": "body", "type": "object", "description": "The content version that should be created.", "customType": "ContentVersion", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] }, { "name": "key", "kind": "optional", "type": "string", "description": "The key that identifies this content version." }, { "name": "locale", "kind": "optional", "type": "string", "description": "The locale of this content version." }, { "name": "version", "kind": "optional", "type": "string", "readOnly": true, "description": "The version identifier of this instance." }, { "name": "variation", "kind": "optional", "type": "string", "description": "

The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.

" }, { "name": "contentType", "kind": "optional", "type": "string", "readOnly": true, "description": "The content type of this content item." }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this content version.", "minLength": 1, "maxLength": 255 }, { "name": "published", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content was published or should be published.", "format": "date-time" }, { "name": "expired", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content expired or should expire.", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "The status of this content version.", "example": "draft", "examples": [ { "value": "draft" }, { "value": "ready" }, { "value": "published" }, { "value": "previous" }, { "value": "scheduled" }, { "value": "rejected" }, { "value": "inReview" } ] }, { "name": "delayPublishUntil", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.", "format": "date-time" }, { "name": "routeSegment", "kind": "optional", "type": "string", "description": "

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.

", "maxLength": 255 }, { "name": "simpleRoute", "kind": "optional", "type": "string", "description": "

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

", "maxLength": 253, "pattern": "^[^/].*$" }, { "name": "lastModified", "kind": "optional", "type": "string", "readOnly": true, "description": "", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "" }, { "name": "composition", "kind": "optional", "type": "object", "description": "

The composition structure of this content version, if any. Only relevant for experiences and sections.

", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Specifies an identifier of this composition node." }, { "name": "displayName", "kind": "optional", "type": "string", "description": "The display name of this composition node.", "maxLength": 255 }, { "name": "nodeType", "kind": "required", "type": "string", "description": "The node type of this composition node.", "minLength": 1 }, { "name": "layoutType", "kind": "optional", "type": "string", "description": "The node layout type of this composition node" }, { "name": "displaySettings", "kind": "optional", "type": "object", "description": "Optional display settings for the composition node.", "modelRef": "#/components/schemas/CompositionDisplaySettings", "customType": "CompositionDisplaySettings", "schema": [ { "name": "displayTemplate", "kind": "required", "type": "string", "description": "The display template that these settings apply to.", "minLength": 1 }, { "name": "settings", "kind": "optional", "type": "map", "nullable": true, "description": "The display settings of this composition node.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "component", "kind": "optional", "type": "object", "description": "

Specifies the associated content for this composition node, if any.

", "modelRef": "#/components/schemas/ContentComponent", "customType": "ContentComponent", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ContentData", "description": "", "modelRef": "#/components/schemas/ContentData", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "object", "description": "", "schema": [ { "name": "reference", "kind": "optional", "type": "string", "nullable": true, "description": "A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.", "format": "uri" }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The key of the content type that this is an embedded instance of." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "The child nodes for this composition node.", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] }, { "name": "media", "kind": "optional", "type": "object", "description": "Media data attached to this content version.", "modelRef": "#/components/schemas/MediaData", "customType": "MediaData", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key referencing the media.", "pattern": "^[a-f0-9]{32}\\.[a-zA-Z0-9]{1,20}$" } ] } ], "modelRef": "#/components/schemas/ContentVersion", "complexItems": [ { "name": "object", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/ContentData", "customType": "ContentData" }, { "name": "object", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key that identifies this content version." }, { "name": "locale", "kind": "optional", "type": "string", "description": "The locale of this content version." }, { "name": "version", "kind": "optional", "type": "string", "readOnly": true, "description": "The version identifier of this instance." }, { "name": "variation", "kind": "optional", "type": "string", "description": "

The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.

" }, { "name": "contentType", "kind": "optional", "type": "string", "readOnly": true, "description": "The content type of this content item." }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this content version.", "minLength": 1, "maxLength": 255 }, { "name": "published", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content was published or should be published.", "format": "date-time" }, { "name": "expired", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content expired or should expire.", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "The status of this content version.", "example": "draft", "examples": [ { "value": "draft" }, { "value": "ready" }, { "value": "published" }, { "value": "previous" }, { "value": "scheduled" }, { "value": "rejected" }, { "value": "inReview" } ] }, { "name": "delayPublishUntil", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.", "format": "date-time" }, { "name": "routeSegment", "kind": "optional", "type": "string", "description": "

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.

", "maxLength": 255 }, { "name": "simpleRoute", "kind": "optional", "type": "string", "description": "

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

", "maxLength": 253, "pattern": "^[^/].*$" }, { "name": "lastModified", "kind": "optional", "type": "string", "readOnly": true, "description": "", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "" }, { "name": "composition", "kind": "optional", "type": "object", "description": "

The composition structure of this content version, if any. Only relevant for experiences and sections.

", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Specifies an identifier of this composition node." }, { "name": "displayName", "kind": "optional", "type": "string", "description": "The display name of this composition node.", "maxLength": 255 }, { "name": "nodeType", "kind": "required", "type": "string", "description": "The node type of this composition node.", "minLength": 1 }, { "name": "layoutType", "kind": "optional", "type": "string", "description": "The node layout type of this composition node" }, { "name": "displaySettings", "kind": "optional", "type": "object", "description": "Optional display settings for the composition node.", "modelRef": "#/components/schemas/CompositionDisplaySettings", "customType": "CompositionDisplaySettings", "schema": [ { "name": "displayTemplate", "kind": "required", "type": "string", "description": "The display template that these settings apply to.", "minLength": 1 }, { "name": "settings", "kind": "optional", "type": "map", "nullable": true, "description": "The display settings of this composition node.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "component", "kind": "optional", "type": "object", "description": "

Specifies the associated content for this composition node, if any.

", "modelRef": "#/components/schemas/ContentComponent", "customType": "ContentComponent", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ContentData", "description": "", "modelRef": "#/components/schemas/ContentData", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "object", "description": "", "schema": [ { "name": "reference", "kind": "optional", "type": "string", "nullable": true, "description": "A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.", "format": "uri" }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The key of the content type that this is an embedded instance of." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "The child nodes for this composition node.", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] }, { "name": "media", "kind": "optional", "type": "object", "description": "Media data attached to this content version.", "modelRef": "#/components/schemas/MediaData", "customType": "MediaData", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key referencing the media.", "pattern": "^[a-f0-9]{32}\\.[a-zA-Z0-9]{1,20}$" } ] } ] } ], "complexType": "allOf", "isExpanded": true } ], "formDataParameters": [], "oAuthParameters": [ { "id": "apiAuth", "name": "apiAuth", "kind": "optional", "type": "oauth2", "description": "Use this scheme to generate an access token that can be used to access the API.", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://api.cms.optimizely.com/oauth/token", "scopes": { "api:admin": "Grants full administrative access to the API" } } }, "requiredScopes": [ "api:admin" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "201", "description": "Created", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "ETag", "type": "string", "description": "

The RFC7232 ETag header field in a response provides the current entity-tag for the resource. An entity-tag is an opaque identifier for different versions of a resource over time, regardless whether multiple versions are valid at the same time.

" }, { "kind": "optional", "name": "Last-Modified", "type": "string", "description": "The date and time at which the resource was last modified.", "format": "http-date" }, { "kind": "optional", "name": "Location", "type": "string", "description": "

Indicates the URL of the newly-created resource.

" }, { "kind": "optional", "name": "Preference-Applied", "description": "" } ], "schema": [ { "kind": "optional", "type": "object", "description": "A version of a content item.", "customType": "ContentVersion", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] }, { "name": "key", "kind": "optional", "type": "string", "description": "The key that identifies this content version." }, { "name": "locale", "kind": "optional", "type": "string", "description": "The locale of this content version." }, { "name": "version", "kind": "optional", "type": "string", "readOnly": true, "description": "The version identifier of this instance." }, { "name": "variation", "kind": "optional", "type": "string", "description": "

The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.

" }, { "name": "contentType", "kind": "optional", "type": "string", "readOnly": true, "description": "The content type of this content item." }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this content version.", "minLength": 1, "maxLength": 255 }, { "name": "published", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content was published or should be published.", "format": "date-time" }, { "name": "expired", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content expired or should expire.", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "The status of this content version.", "example": "draft", "examples": [ { "value": "draft" }, { "value": "ready" }, { "value": "published" }, { "value": "previous" }, { "value": "scheduled" }, { "value": "rejected" }, { "value": "inReview" } ] }, { "name": "delayPublishUntil", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.", "format": "date-time" }, { "name": "routeSegment", "kind": "optional", "type": "string", "description": "

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.

", "maxLength": 255 }, { "name": "simpleRoute", "kind": "optional", "type": "string", "description": "

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

", "maxLength": 253, "pattern": "^[^/].*$" }, { "name": "lastModified", "kind": "optional", "type": "string", "readOnly": true, "description": "", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "" }, { "name": "composition", "kind": "optional", "type": "object", "description": "

The composition structure of this content version, if any. Only relevant for experiences and sections.

", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Specifies an identifier of this composition node." }, { "name": "displayName", "kind": "optional", "type": "string", "description": "The display name of this composition node.", "maxLength": 255 }, { "name": "nodeType", "kind": "required", "type": "string", "description": "The node type of this composition node.", "minLength": 1 }, { "name": "layoutType", "kind": "optional", "type": "string", "description": "The node layout type of this composition node" }, { "name": "displaySettings", "kind": "optional", "type": "object", "description": "Optional display settings for the composition node.", "modelRef": "#/components/schemas/CompositionDisplaySettings", "customType": "CompositionDisplaySettings", "schema": [ { "name": "displayTemplate", "kind": "required", "type": "string", "description": "The display template that these settings apply to.", "minLength": 1 }, { "name": "settings", "kind": "optional", "type": "map", "nullable": true, "description": "The display settings of this composition node.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "component", "kind": "optional", "type": "object", "description": "

Specifies the associated content for this composition node, if any.

", "modelRef": "#/components/schemas/ContentComponent", "customType": "ContentComponent", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ContentData", "description": "", "modelRef": "#/components/schemas/ContentData", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "object", "description": "", "schema": [ { "name": "reference", "kind": "optional", "type": "string", "nullable": true, "description": "A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.", "format": "uri" }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The key of the content type that this is an embedded instance of." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "The child nodes for this composition node.", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] }, { "name": "media", "kind": "optional", "type": "object", "description": "Media data attached to this content version.", "modelRef": "#/components/schemas/MediaData", "customType": "MediaData", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key referencing the media.", "pattern": "^[a-f0-9]{32}\\.[a-zA-Z0-9]{1,20}$" } ] } ], "modelRef": "#/components/schemas/ContentVersion", "complexItems": [ { "name": "object", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ], "modelRef": "#/components/schemas/ContentData", "customType": "ContentData" }, { "name": "object", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key that identifies this content version." }, { "name": "locale", "kind": "optional", "type": "string", "description": "The locale of this content version." }, { "name": "version", "kind": "optional", "type": "string", "readOnly": true, "description": "The version identifier of this instance." }, { "name": "variation", "kind": "optional", "type": "string", "description": "

The variation of this content version, if any. Variations are used to represent different states or forms of the same content item. A variation has its own publishing lifecycle. A variation cannot be published before the default version of same locale has been published.

" }, { "name": "contentType", "kind": "optional", "type": "string", "readOnly": true, "description": "The content type of this content item." }, { "name": "displayName", "kind": "required", "type": "string", "description": "The display name of this content version.", "minLength": 1, "maxLength": 255 }, { "name": "published", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content was published or should be published.", "format": "date-time" }, { "name": "expired", "kind": "optional", "type": "string", "nullable": true, "description": "Indicates a time when this content expired or should expire.", "format": "date-time" }, { "name": "status", "kind": "optional", "type": "string", "readOnly": true, "description": "The status of this content version.", "example": "draft", "examples": [ { "value": "draft" }, { "value": "ready" }, { "value": "published" }, { "value": "previous" }, { "value": "scheduled" }, { "value": "rejected" }, { "value": "inReview" } ] }, { "name": "delayPublishUntil", "kind": "optional", "type": "string", "readOnly": true, "nullable": true, "description": "The timestamp when a scheduled version will be published. Only present when status is 'scheduled'.", "format": "date-time" }, { "name": "routeSegment", "kind": "optional", "type": "string", "description": "

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.

", "maxLength": 255 }, { "name": "simpleRoute", "kind": "optional", "type": "string", "description": "

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

", "maxLength": 253, "pattern": "^[^/].*$" }, { "name": "lastModified", "kind": "optional", "type": "string", "readOnly": true, "description": "", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "" }, { "name": "composition", "kind": "optional", "type": "object", "description": "

The composition structure of this content version, if any. Only relevant for experiences and sections.

", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Specifies an identifier of this composition node." }, { "name": "displayName", "kind": "optional", "type": "string", "description": "The display name of this composition node.", "maxLength": 255 }, { "name": "nodeType", "kind": "required", "type": "string", "description": "The node type of this composition node.", "minLength": 1 }, { "name": "layoutType", "kind": "optional", "type": "string", "description": "The node layout type of this composition node" }, { "name": "displaySettings", "kind": "optional", "type": "object", "description": "Optional display settings for the composition node.", "modelRef": "#/components/schemas/CompositionDisplaySettings", "customType": "CompositionDisplaySettings", "schema": [ { "name": "displayTemplate", "kind": "required", "type": "string", "description": "The display template that these settings apply to.", "minLength": 1 }, { "name": "settings", "kind": "optional", "type": "map", "nullable": true, "description": "The display settings of this composition node.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "component", "kind": "optional", "type": "object", "description": "

Specifies the associated content for this composition node, if any.

", "modelRef": "#/components/schemas/ContentComponent", "customType": "ContentComponent", "schema": [], "complexType": "allOf", "complexItems": [ { "name": "ContentData", "description": "", "modelRef": "#/components/schemas/ContentData", "schema": [ { "name": "binding", "kind": "optional", "type": "object", "description": "Optional binding to another content item.", "modelRef": "#/components/schemas/ContentBinding", "customType": "ContentBinding", "schema": [ { "name": "contentTypeBinding", "kind": "optional", "type": "string", "description": "The binding definition key that controls how the source content item is linked and accessed." }, { "name": "source", "kind": "required", "type": "string", "description": "The reference to the source content item that is being bound. This cannot be empty.", "format": "uri" } ] }, { "name": "properties", "kind": "optional", "type": "map", "description": "Properties as they are defined by corresponding component or content type.", "example": "", "customType": "map", "schema": [] } ] }, { "name": "object", "description": "", "schema": [ { "name": "reference", "kind": "optional", "type": "string", "nullable": true, "description": "A reference to the content of this component. Cannot be assigned together with 'contentType' or 'properties'.", "format": "uri" }, { "name": "contentType", "kind": "optional", "type": "string", "description": "The key of the content type that this is an embedded instance of." } ] } ] }, { "name": "nodes", "kind": "optional", "type": "array", "nullable": true, "description": "The child nodes for this composition node.", "modelRef": "#/components/schemas/CompositionNode", "customType": "CompositionNode[]", "schema": [ { "name": "", "description": "", "customType": "Circular-Reference" } ] } ] }, { "name": "media", "kind": "optional", "type": "object", "description": "Media data attached to this content version.", "modelRef": "#/components/schemas/MediaData", "customType": "MediaData", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "The key referencing the media.", "pattern": "^[a-f0-9]{32}\\.[a-zA-Z0-9]{1,20}$" } ] } ] } ], "complexType": "allOf", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true }, { "statusCode": "409", "description": "Conflict", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Too Many Requests", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "Retry-After", "type": "number", "description": "Indicates how long the client should wait before making a new request." } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ProblemDetails", "schema": [ { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "A URI reference that identifies the problem type.", "format": "uri" }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "

A short, human-readable summary of the problem type.

" }, { "name": "status", "kind": "optional", "type": "integer", "nullable": true, "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "format": "int32", "minimum": 100, "maximum": 599 }, { "name": "detail", "kind": "optional", "type": "string", "nullable": true, "description": "

A human-readable explanation specific to this occurrence of the problem.

" }, { "name": "instance", "kind": "optional", "type": "string", "nullable": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "format": "uri" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Error code that identifies the problem type." }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "An array of error details with more detailed information about the problem.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "detail", "kind": "optional", "type": "string", "description": "

A granular explanation of one specific error related to a field, header or query parameter.

" }, { "name": "field", "kind": "optional", "type": "string", "nullable": true, "description": "A string that may provide a hint to which field that was the source of the error.", "example": "properties.header.displayName" } ] } ], "modelRef": "#/components/schemas/ProblemDetails", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "RV499usW5ANHjV3VVI1dk", "language": "curl", "label": "cURL", "code": "curl --request POST \\\n --url https://api.cms.optimizely.com/v1/content/{key}/versions \\\n --header 'accept: application/json' \\\n --header 'content-type: application/json' \\\n --data '{\n \"binding\": {\n \"source\": \"\"\n },\n \"displayName\": \"\",\n \"composition\": {\n \"nodeType\": \"\",\n \"displaySettings\": {\n \"displayTemplate\": \"\"\n },\n \"component\": {\n \"binding\": {\n \"source\": \"\"\n }\n }\n }\n }'" }, { "id": "WETDhuMbrEe8tnh6CSr2N", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar raw = JSON.stringify({\n \"binding\": {\n \"source\": \"\"\n },\n \"displayName\": \"\",\n \"composition\": {\n \"nodeType\": \"\",\n \"displaySettings\": {\n \"displayTemplate\": \"\"\n },\n \"component\": {\n \"binding\": {\n \"source\": \"\"\n }\n }\n }\n});\n\nvar requestOptions = {\n method: 'POST',\n headers: myHeaders,\n body: raw,\n redirect: 'follow'\n};\n\nfetch(\"https://api.cms.optimizely.com/v1/content/{key}/versions\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "pPATZ6m-pqHUbwMJxK-8g", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.cms.optimizely.com/v1/content/{key}/versions\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Post.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\nrequest.body = JSON.dump({\n \"binding\": {\n \"source\": \"\"\n },\n \"displayName\": \"\",\n \"composition\": {\n \"nodeType\": \"\",\n \"displaySettings\": {\n \"displayTemplate\": \"\"\n },\n \"component\": {\n \"binding\": {\n \"source\": \"\"\n }\n }\n }\n})\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "XMCcIPPXyJDwnEAkDaGpj", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.cms.optimizely.com/v1/content/{key}/versions\"\n\npayload = json.dumps({\n \"binding\": {\n \"source\": \"\"\n },\n \"displayName\": \"\",\n \"composition\": {\n \"nodeType\": \"\",\n \"displaySettings\": {\n \"displayTemplate\": \"\"\n },\n \"component\": {\n \"binding\": {\n \"source\": \"\"\n }\n }\n }\n})\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"POST\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "RV499usW5ANHjV3VVI1dk" }, "results": { "languages": [ { "id": "response-0-201", "language": "201", "code": "// Created\n{\n \"binding\": {\n \"contentTypeBinding\": \"\",\n \"source\": \"\"\n },\n \"properties\": \"\",\n \"key\": \"\",\n \"locale\": \"\",\n \"version\": \"\",\n \"variation\": \"\",\n \"contentType\": \"\",\n \"displayName\": \"\",\n \"published\": \"\",\n \"expired\": \"\",\n \"status\": \"draft\",\n \"delayPublishUntil\": \"\",\n \"routeSegment\": \"\",\n \"simpleRoute\": \"\",\n \"lastModified\": \"\",\n \"lastModifiedBy\": \"\",\n \"composition\": {\n \"id\": \"\",\n \"displayName\": \"\",\n \"nodeType\": \"\",\n \"layoutType\": \"\",\n \"displaySettings\": {\n \"displayTemplate\": \"\",\n \"settings\": \"\"\n },\n \"component\": {},\n \"nodes\": [\n {\n \"\": \"\"\n }\n ]\n },\n \"media\": {\n \"key\": \"\"\n }\n}" }, { "id": "response-1-400", "language": "400", "code": "// Bad Request\n" }, { "id": "response-2-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-3-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-4-404", "language": "404", "code": "// Not Found\n" }, { "id": "response-5-409", "language": "409", "code": "// Conflict\n" }, { "id": "response-6-429", "language": "429", "code": "// Too Many Requests\n{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"errors\": [\n {\n \"detail\": \"\",\n \"field\": \"properties.header.displayName\"\n }\n ]\n}" }, { "id": "response-7-500", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-201" } }, "children": [ { "text": "" } ] }