Bundle CMF

Create segment group

Changed on

Creates a new customer segment group.

post/pimcore-studio/api/bundle/cmf/segment-groups

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/bundle/cmf/segment-groups
  • Auth: none declared

Request body

namestring required

Segment group name

referencestring nullable

Segment group reference string

calculatedboolean nullable

Whether the segment group is calculated (automatic)

Example request

{
  "name": "Customer Type",
  "reference": "customer-type"
}

Response

Newly created segment group data

additionalAttributesobject

AdditionalAttributes

idinteger required

Segment group object ID

namestring required

Segment group name

calculatedboolean required

Whether the segment group is calculated (automatic)

referencestring nullable

Segment group reference string

Example response

{
  "id": 5,
  "name": "Customer Type",
  "reference": "customer-type"
}

Changes