Bundle CMF

Create customer

Creates a new customer object using the configured customer provider.

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

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

emailstring required

Customer email address

activeboolean nullable

Whether the customer should be active

dataobject nullable

Additional customer field values as key-value pairs

{
  "email": "new@example.com",
  "active": true
}

Newly created customer data

additionalAttributesobject

AdditionalAttributes

idinteger required

Customer object ID

activeboolean required

Whether the customer is active

emailstring required

Customer email address

segmentsinteger[]

Segment IDs assigned to this customer

activitiesobject[] nullable

Activity data (only present when includeActivities=true)

dataobject

All raw CMF fields returned by cmfToArray()

{
  "id": 42,
  "active": true,
  "email": "jane@example.com",
  "segments": [
    1,
    2,
    3
  ]
}