Create segmentation rule for booking

POST

/booking/segmentation-rule

Creates a new segmentation rule and associates it with either a new booking
or an existing booking. This endpoint handles complex asset allocation and
availability management.

Business Rules:

Either newBooking or existingBookingId must be provided (mutually exclusive)

When newBooking is provided, a new booking is created with the segmentation rule

When existingBookingId is provided, the segmentation rule is added to the existing booking

Asset availability is automatically managed based on booking status

Jumbo business rules are applied when booking status is 'booked'

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Segmentation rule created successfully

Body

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Create new booking with segmentation ruleAdd segmentation rule to existing bookingComplex segmentation rule with multiple filters

curl --location --request POST 'https://prod.your-api-server.com/booking/segmentation-rule' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "segmentationRule": {
        "name": "Premium Store Selection",
        "rules": {
            "rule": "and",
            "filters": [
                {
                    "rule": "and",
                    "filters": [
                        {
                            "rule": "and",
                            "filters": [
                                {
                                    "property": "store-list",
                                    "operator": "in",
                                    "value": "123e4567-e89b-12d3-a456-426614174000",
                                    "id": "123e4567-e89b-12d3-a456-426614174000"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "targetAssetIds": [
            "987fcdeb-51a2-43d1-9f12-345678901234"
        ]
    },
    "newBooking": {
        "name": "Q1 2024 Campaign",
        "assetIds": [
            "987fcdeb-51a2-43d1-9f12-345678901234"
        ],
        "startDate": "2024-01-01",
        "endDate": "2024-03-31",
        "status": "reserved"
    },
    "categoryFilters": [
        "electronics",
        "fashion"
    ]
}'

Response Example

200 - Successful booking creation with segmentation rule

{
    "_id": "456e7890-e89b-12d3-a456-426614174000",
    "name": "Q1 2024 Campaign",
    "code": "BOOK-2024-001",
    "assetIds": [
        "987fcdeb-51a2-43d1-9f12-345678901234",
        "111fcdeb-51a2-43d1-9f12-345678901234"
    ],
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-03-31T23:59:59.999Z",
    "status": "reserved",
    "campaignIds": [],
    "tradingPeriodIds": [],
    "categoryFilters": {
        "123e4567-e89b-12d3-a456-426614174001": [
            "electronics",
            "fashion"
        ]
    },
    "unavailableAssetIds": [
        {
            "bookedAssetId": "111fcdeb-51a2-43d1-9f12-345678901234",
            "unavailableAssetId": "222fcdeb-51a2-43d1-9f12-345678901234"
        }
    ],
    "segmentationRuleId": "seg-rule-uuid-123",
    "createdAt": "2024-01-01T10:00:00.000Z",
    "updatedAt": "2024-01-01T10:00:00.000Z"
}

Modified at 2025-09-25 10:04:16

Update booking

Get single booking by ID