Update a campaign item

PATCH

/campaign-item/{id}

Updates an existing campaign item with provided fields.

Business Rules:

Campaign item and associated campaign must not be locked

Empty allocation rules set status to Draft and hasAllocations to false

Non-empty allocation rules set hasAllocations to true and status to Ready if artwork exists

Status changes trigger campaign state updates (InProgress ↔ ReadyToPublish)

Priority allocation changes update campaign asset groups

MOS information sync triggers campaign postFederationAPI flag

Trigger Fields for Republishing:

oversType, oversValue, perBoxQty, warehouseQuantity, warehouseType, allocationRules

Side Effects:

Updates campaign state based on all campaign items' status

Triggers campaign publish if certain fields are modified

Removes/adds items from campaign asset groups based on priority allocation

Updates campaign MOS status flag

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Campaign item updated successfully

Body

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

Update quantity and allocation rulesUpdate status to cancelledRemove from priority allocation

curl --location --request PATCH 'https://prod.your-api-server.com/campaign-item/880e8400-e29b-41d4-a716-446655440003' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "qty": 750,
    "allocationRules": [
        {
            "property": "store",
            "rule": "include",
            "values": [
                "STORE001",
                "STORE002",
                "STORE003"
            ],
            "quantities": [
                250,
                250,
                250
            ]
        }
    ]
}'

Response Example

200 - Successfully updated campaign item

{
    "_id": "880e8400-e29b-41d4-a716-446655440003",
    "clientId": "client123",
    "campaignId": {
        "_id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Summer Sale 2025",
        "state": 101
    },
    "itemId": {
        "_id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Promotional Flyer",
        "posNumber": "FLY001"
    },
    "assetId": "770e8400-e29b-41d4-a716-446655440002",
    "status": 102,
    "qty": 750,
    "fixedPrice": 25.5,
    "oversType": "percent",
    "oversValue": 10,
    "warehouseType": "percent",
    "warehouseQuantity": 75,
    "total": 825,
    "isActive": true,
    "isPriorityAllocation": false,
    "hasArtwork": true,
    "hasAllocations": true,
    "allocationRules": [
        {
            "property": "store",
            "rule": "include",
            "values": [
                "STORE001",
                "STORE002",
                "STORE003"
            ],
            "quantities": [
                250,
                250,
                250
            ]
        }
    ],
    "meta": {
        "customField1": "Summer Campaign"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T15:45:00Z"
}

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

Get a single campaign item

Delete a campaign item