 Optimizely Content Management System (CMS) (SaaS) has a REST API to manage resources.  See the developer guide for available Resource types .

Introduction to the CMS (SaaS) REST API

 To use CMS (SaaS) REST API, you must authenticate calls with a bearer JSON Web Token (JWT) by requesting a JWT from the token endpoint https //docs. developers.

Authentication and authorization

 Experimental APIs are features or functionalities that are in the early stages of development.  They are not ready for general use and may change significantly or be removed in future updates.

Experimental APIs

 Migration from preview3 to V1 has a lot of breaking changes between the Optimizely CMS Content API preview3 and v1 versions.  Use this guide when migrating an existing integration from preview3 to the stable v1 API.

Migrate from Content API preview3 to v1

Get started

ai_cta

ai_identity

ai_chat

ai_product


Data set that refers to a person or a role and contains at least one address via which the person or role can receive messages.

recipient

cms-saas-api-docs

CMS (SaaS) REST API

Migration checklist

Content Type API Recipes

Request access token

Get content node

Create a new content item

API Recipes

Introduction

List applications

Create application

Get application

Patch application

Delete application

Applications

List blueprints

Create blueprint

Get blueprint

Patch blueprint

Delete blueprint

Blueprints

Create content

Copy content

Restore content

Patch content

Delete content

List assets

List content in container

List locale versions

Delete locale

Get content path

List versions

Create version

Approve the active step of an approval for a content version that is in review. For multi-step approvals, the version remains in review until all steps are approved.

Change content version into draft status.

Publish content version

Make content ready to publish, if approvals are required the version will automatically be moved to in review.

Reject a content version that is in review. The version transitions to rejected status regardless of remaining approval steps.

Get version

Patch version

Delete version

Download content media file.

Get preview URLs for a content item version.

Query versions

Content

List content sources

Create contentsource

Get contentsource

Patch contentsource

Delete contentsource

ContentSources

List content type bindings

Create contenttypebinding

Get contenttypebinding

Patch contenttypebinding

Delete contenttypebinding

ContentTypeBindings

List content types

Create content type

Get content type

Patch content type

Delete content type

ContentTypes

List display templates

Create display template

Get display template

Patch display template

Delete display template

DisplayTemplates

List locales

Create locale

Get locale

Patch locale

Locales

Export manifest

Import manifest

Manifest

List property formats

Get property format

PropertyFormats

List property groups

Create property group

Get property group

Patch property group

Delete property group

PropertyGroups

Download OpenAPI file

Model: Application

Model: ApplicationHost

Model: ApplicationHostPatch

Model: ApplicationPage

Model: ApplicationPatch

Model: ApprovalDecisionOptions

Model: ArrayItem

Model: Blueprint

Model: BlueprintData

Model: BlueprintDataPatch

Model: BlueprintPage

Model: BlueprintPatch

Model: CompositionConfiguration

Model: CompositionConfigurationPatch

Model: CompositionDisplaySettings

Model: CompositionDisplaySettingsPatch

Model: CompositionNode

Model: CompositionNodePatch

Model: ContentBinding

Model: ContentBindingPatch

Model: ContentComponent

Model: ContentComponentPatch

Model: ContentData

Model: ContentDataPatch

Model: ContentNode

Model: ContentNodePage

Model: ContentNodePatch

Model: ContentSource

Model: ContentSourcePage

Model: ContentSourcePatch

Model: ContentType

Model: ContentTypeBinding

Model: ContentTypeBindingPage

Model: ContentTypeBindingPatch

Model: ContentTypePage

Model: ContentTypePatch

Model: ContentTypeProperty

Model: ContentVersion

Model: ContentVersionPage

Model: ContentVersionPatch

Model: CopyContentOptions

Model: DisplaySetting

Model: DisplaySettingChoice

Model: DisplayTemplate

Model: DisplayTemplatePage

Model: DisplayTemplatePatch

Model: EnumerationValue

Model: Link

Model: Locale

Model: LocalePage

Model: LocalePatch

Model: Manifest

Model: ManifestImportMessage

Model: ManifestImportResult

Model: MediaData

Model: MediaDataPatch

Model: NewContent

Model: NewContentNode

Model: Preview

Model: PreviewPage

Model: ProblemDetails

Model: PropertyData

Model: PropertyFormat

Model: PropertyFormatPage

Model: PropertyGroup

Model: PropertyGroupPage

Model: PropertyGroupPatch

Model: PropertyMapping

Model: PropertyMappings

Model: PropertyMappingsPatch

Model: PublishContentOptions

Model: ReadyContentOptions

Model: RichText

Model: SecurityIdentity

Model: SecurityIdentityPatch

Models

Optimizely CMS REST API - Content