HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

Property groups

Describes the Property group resource and how to work with them.

πŸ‘

Beta

Optimizely SaaS Core is in beta. Apply on Join the waitlist for SaaS Core or contact your Customer Success Manager.

Property groups are defining groups that content properties are organized in.

The property group resource contains the following fields:

TitleFieldDescription
KeykeyA string identifying the property group in the API.
Display namedisplayNameA user-friendly name for the group that is displayed to end users.
Sort ordersortOrderA relative index used in some listings to define the order of property groups.
SourcesourceA key indicating where this group came from. Will be empty when created from the UI. Set to system when defined by Optimizely Content Management System (CMS).

Work with property groups

List all property groups

Retrieve a list of all property groups through the Property Group API.

GET https://example.com/_cms/v1/contentpropertygroups
[
    {
        "key": "info",
        "displayName": "Information",
        "sortOrder": 10,
        "source": ""
    },
    {
        "key": "settings",
        "displayName": "Setting",
        "sortOrder": 20,
        "source": "system"
    }
]

Get a property group

Retrieve a specific property group through the Property Group API using its unique key.

GET https://example.com/_cms/v1/contentpropertygroups/info
{
    "key": "info",
    "displayName": "Information",
    "sortOrder": 42,
    "source": ""
}

Create a property group

Create a property group through the Property Group API. A property group must have a unique key.

POST https://example.com/_cms/v1/contentpropertygroups
Content-Type: application/json

{
    "key": "info",
    "displayName": "Information"
}

Update an existing property group

Update an existing property group through the Property Group API. Groups created by the CMS with source set to system are read-only and cannot be updated.

PUT https://example.com/_cms/v1/contentpropertygroups/info
Content-Type: application/json

{
    "key": "info",
    "displayName": "Infotainment"
    "sortOrder": 150
}

You can modify individual property group field values. The updated property group will be returned in the response.

PATCH https://example.com/_cms/v1/contentpropertygroups/info
Content-Type: application/merge-patch+json

{
    "sortOrder": 150
}
{
    "key": "info",
    "displayName": "Infotainment"
    "sortOrder": 150,
    "source": ""
}

Delete a property group

Delete an existing property group through the Property Group API.

DELETE https://example.com/_cms/v1/contentpropertygroups/info