Update booking segmentation

POST

/booking/{id}/update-segmentation

Updates the segmentation configuration for a booking, including asset selection and filtering rules.

Business Rules:

Must provide either segmentationRuleId (for multi-segmentation) or full segmentation rule

Asset IDs must reference assets currently associated with the booking

Trading period IDs must be valid and accessible to the user

Category filters are applied to asset selection logic

Unavailable asset mappings prevent conflicts with other bookings

Segmentation updates may affect asset availability calculations

Multi-Segmentation Support:

When segmentationRuleId is provided, updates specific segmentation rule

When segmentationRuleName is provided, updates the rule name

Legacy mode (no segmentationRuleId) updates the primary booking segmentation

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Segmentation updated successfully

Body

🟠400Bad Request

🟠404Not Found

🟠409Conflict

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Basic segmentation updateMulti-segmentation rule updateComplex multi-criteria update

curl --location --request POST 'https://prod.your-api-server.com/booking/456e7890-e89b-12d3-a456-426614174000/update-segmentation' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "selectedAssetIds": [
        "987fcdeb-51a2-43d1-9f12-345678901234",
        "111fcdeb-51a2-43d1-9f12-345678901234"
    ],
    "tradingPeriodIds": [
        "123e4567-e89b-12d3-a456-426614174000"
    ],
    "categoryFilters": [
        "electronics",
        "fashion"
    ],
    "segmentationRule": {
        "rule": "and",
        "filters": [
            {
                "rule": "and",
                "filters": [
                    {
                        "property": "feature",
                        "operator": "eq",
                        "value": "high-traffic"
                    }
                ]
            }
        ]
    },
    "unavailableAssetIds": [
        {
            "bookedAssetId": "111fcdeb-51a2-43d1-9f12-345678901234",
            "unavailableAssetId": "222fcdeb-51a2-43d1-9f12-345678901234"
        }
    ]
}'

Response Example

200 - Successfully updated booking segmentation

{
    "_id": "456e7890-e89b-12d3-a456-426614174000",
    "name": "Q1 2024 Campaign",
    "code": "BOOK-2024-001",
    "isActive": true,
    "meta": {},
    "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": [
        "123e4567-e89b-12d3-a456-426614174000"
    ],
    "categoryFilters": {
        "123e4567-e89b-12d3-a456-426614174000": [
            "electronics",
            "fashion"
        ]
    },
    "unavailableAssetIds": [
        {
            "bookedAssetId": "111fcdeb-51a2-43d1-9f12-345678901234",
            "unavailableAssetId": "222fcdeb-51a2-43d1-9f12-345678901234"
        }
    ],
    "segmentationRuleId": "seg-rule-updated-123",
    "creator": {
        "_id": "user-creator-uuid",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com"
    },
    "owners": [
        {
            "_id": "user-owner-uuid-1",
            "firstName": "Jane",
            "lastName": "Smith",
            "email": "jane.smith@example.com"
        }
    ],
    "createdAt": "2024-01-01T10:00:00.000Z",
    "updatedAt": "2024-01-01T15:45:00.000Z",
    "updates": [
        {
            "_id": "update-uuid-2",
            "bookingId": "456e7890-e89b-12d3-a456-426614174000",
            "area": "segmentation",
            "assetsIdsToUse": [
                "987fcdeb-51a2-43d1-9f12-345678901234",
                "111fcdeb-51a2-43d1-9f12-345678901234"
            ],
            "seenBy": [],
            "createdAt": "2024-01-01T15:45:00.000Z"
        }
    ]
}

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

Update asset status for booking

Refresh booking segmentation