Add Customer Segment

POST

/desktop/customer-segments/create

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Examples

Responses

🟢200New Request

application/json

Body

🟢200New Request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/desktop/customer-segments/create' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Newsletter Subscribers",
  "description": "Customers subscribed to the newsletter",
  "icon": "https://cdn.example.com/icons/newsletter.png",
  "criteria": { "subscribedToNewsletter": true },
  "isActive": true
}'

Response Example

200 - New Request - New Request

{
    "success": true,
    "message": "Business customer segment created successfully!",
    "data": {
        "name": "Newsletter Subscribers",
        "description": "Customers subscribed to the newsletter",
        "icon": "https://cdn.example.com/icons/newsletter.png",
        "criteria": "{\"subscribedToNewsletter\":true}",
        "is_active": true,
        "business_id": 133,
        "user_id": "2",
        "is_default": false,
        "segment_type": "custom",
        "raw": "",
        "created_at": "2025-07-07T22:58:17.982+01:00",
        "updated_at": "2025-07-07T22:58:17.982+01:00",
        "id": "6"
    }
}

Modified at 2025-09-01 22:54:16

Get Pdf downloable reports

Get All Customer Segment