Get started

Introduction to the CMS (SaaS) REST API
Authentication and authorization

Optimizely CMS Content API

Changesets
Content
ContentTypes
DisplayTemplates
Oauth
- Request access tokenpost
Packages
PropertyFormats
- List property formatsget
- Get property formatget
PropertyGroups

Get started

Introduction to the CMS (SaaS) REST API
Authentication and authorization

Optimizely CMS Content API

Changesets
Content
ContentTypes
DisplayTemplates
Oauth
- Request access tokenpost
Packages
PropertyFormats
- List property formatsget
- Get property formatget
PropertyGroups

Create display template

post https://example.com/_cms/preview2/displaytemplates

Create a new display template.

New Requests

URL Expired

The URL for this request expired after 30 days.

Body Params

The display template that should be created.

displayName

string

required

length between 1 and 255

The display name of this display template.

nodeType

string | null

The optional node type this display template is valid for.

baseType

string

Represent the base type of a ContentType.

contentType

string | null

The optional key of the content type this display template is valid for.

isDefault

boolean

If this is the default display template for the associated base type,
node type or content type.

settings

object

The available settings for this display template.

Responses

Response body

object

key

string

required

length between 2 and 255

The key that identifies this display template.

displayName

string

required

length between 1 and 255

The display name of this display template.

nodeType

string | null

The optional node type this display template is valid for.

baseType

string

Represent the base type of a ContentType.

page component media image video folder experience section element

contentType

string | null

The optional key of the content type this display template is valid for.

isDefault

boolean

If this is the default display template for the associated base type,
node type or content type.

created

date-time

A timestamp indicating when this display template was first created.

createdBy

string

The username of the user that created this display template.

lastModified

date-time

A timestamp indicating when this display template was last modified.

lastModifiedBy

string

The username of the user that last modified this display template.

settings

object

The available settings for this display template.

Response body

object

type

string | null

title

string | null

status

int32 | null

detail

string | null

instance

string | null

code

string | null

errors

object | null

Response body

object

type

string | null

title

string | null

status

int32 | null

detail

string | null

instance

string | null

code

string | null

errors

object | null

Updated 9 months ago

List display templates

Get display template

Did this page help you?

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/_cms/preview2/displaytemplates \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Select from the Examples drop-down list. Or choose an example:

Select from the Examples drop-down list.

Updated 9 months ago

List display templates

Get display template

Did this page help you?

Get started
Introduction to the CMS (SaaS) REST API
Authentication and authorization

Optimizely CMS Content API
Changesets
Update changeset itemput
Create changeset itempost
List changeset itemsget
Delete changeset itemdelete
Get changeset itemget
Create or replace changesetput
Delete changesetdelete
Get changesetget
Create changesetpost
List changesetget
Content
Delete versiondelete
Update versionpatch
Get versionget
Delete localedelete
Create versionpost
List versionsget
Query versionsget
Restore contentpost
Copy contentpost
List assetsget
List content in containerget
Get content pathget
Delete contentdelete
Update contentpatch
Get contentget
Create contentpost
ContentTypes
Delete content typedelete
Update content typepatch
Create or replace content typeput
Get content typeget
Create content typepost
List content typesget
DisplayTemplates
Delete display templatedelete
Update display templatepatch
Create or replace a display templateput
Get display templateget
Create display templatepost
List display templatesget
Oauth
Request access tokenpost
Packages
Import packagepost
Export packageget
Get job statusget
PropertyFormats
Get property formatget
List property formatsget
PropertyGroups
Delete property groupdelete
Update property grouppatch
Create or replace property groupput
Get property groupget
Create property grouppost
List property groupsget

Get started
Introduction to the CMS (SaaS) REST API
Authentication and authorization

Optimizely CMS Content API
Changesets
Update changeset itemput
Create changeset itempost
List changeset itemsget
Delete changeset itemdelete
Get changeset itemget
Create or replace changesetput
Delete changesetdelete
Get changesetget
Create changesetpost
List changesetget
Content
Delete versiondelete
Update versionpatch
Get versionget
Delete localedelete
Create versionpost
List versionsget
Query versionsget
Restore contentpost
Copy contentpost
List assetsget
List content in containerget
Get content pathget
Delete contentdelete
Update contentpatch
Get contentget
Create contentpost
ContentTypes
Delete content typedelete
Update content typepatch
Create or replace content typeput
Get content typeget
Create content typepost
List content typesget
DisplayTemplates
Delete display templatedelete
Update display templatepatch
Create or replace a display templateput
Get display templateget
Create display templatepost
List display templatesget
Oauth
Request access tokenpost
Packages
Import packagepost
Export packageget
Get job statusget
PropertyFormats
Get property formatget
List property formatsget
PropertyGroups
Delete property groupdelete
Update property grouppatch
Create or replace property groupput
Get property groupget
Create property grouppost
List property groupsget

Optimizely developer documentation

How can we help you?

Optimizely developer documentation

How can we help you?

Create display template

200OK

400Bad Request

403Forbidden