Property groups

Property groups organize content properties into groups.

The property group resource contains the following fields:

• key – A string identifying the property group in the API.
• displayName – A user-friendly name for the group displayed to end users.
• sortOrder – A relative index used in some listings to define the order of property groups.
• source – A key indicating where this group came from. It is empty when created from the UI and set to system when defined by Optimizely Content Management System (CMS) (SaaS).

GET https://example.com/_cms/version2/contentpropertygroups

{
    "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/version2/contentpropertygroups
Content-Type: application/json

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

See Create property group API reference.

Update a property group

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

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

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

You can modify individual property group field values. The response returns the updated property group.

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

{
    "sortOrder": 150
}

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

See Update property group API reference.

List property groups

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

GET https://example.com/_cms/version2/contentpropertygroups

[
    {
        "key": "info",
        "displayName": "Information",
        "sortOrder": 10,
        "source": ""
    },
    {
        "key": "settings",
        "displayName": "Setting",
        "sortOrder": 20,
        "source": "system"
    }
]

See List property groups API reference.

Get a property group

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

GET https://example.com/_cms/version2/contentpropertygroups

{
    "key": "info",
    "displayName": "Information",
    "sortOrder": 42,
    "source": ""
}

See Get property group API reference.

Delete a property group

Delete an existing property group through the Property Group API.

DELETE https://example.com/_cms/version2/contentpropertygroups

See Delete property group API reference