Bundle CMF

Create segment

Changed on

Creates a new customer segment within a segment group.

post/pimcore-studio/api/bundle/cmf/segments

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/segments
  • Auth: none declared

Request body

namestring required

Segment name

groupinteger required

ID of the segment group to create the segment in

referencestring nullable

Segment reference string

calculatedboolean nullable

Whether the segment is calculated (automatic)

subFolderstring nullable

Optional subfolder within the segment group

Example request

{
  "name": "Gold Members",
  "group": 5,
  "reference": "gold-members"
}

Response

Newly created segment data

additionalAttributesobject

AdditionalAttributes

idinteger required

Segment object ID

namestring required

Segment name

calculatedboolean required

Whether the segment is calculated (automatic)

referencestring nullable

Segment reference string

groupinteger nullable

ID of the segment group this segment belongs to

Example response

{
  "id": 10,
  "name": "Gold Members",
  "reference": "gold-members",
  "group": 5
}

Changes