Update an existing campaign

PATCH

/campaign/{id}

Updates an existing campaign with new data. Supports partial updates.

Business Rules:

Campaign must not be locked for editing

User must have permission to edit the campaign

Version number is automatically incremented

Some fields may be read-only based on campaign state

Status changes must follow valid state transitions

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Campaign updated successfully

Body

🟠400Bad Request

🟠403Forbidden

🟠404Not Found

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://prod.your-api-server.com/campaign/550e8400-e29b-41d4-a716-446655440000' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "campaignType": [
        "string"
    ],
    "itemType": "string",
    "department": [
        "string"
    ],
    "region": [
        "string"
    ],
    "brand": [
        "string"
    ],
    "priority": "string",
    "season": "string",
    "month": "string",
    "year": "string",
    "startAt": "2019-08-24T14:15:22Z",
    "endAt": "2019-08-24T14:15:22Z",
    "launchDate": "2019-08-24T14:15:22Z",
    "dueInStoreDate": "2019-08-24T14:15:22Z",
    "dispatchBy": "2019-08-24T14:15:22Z",
    "finishBy": "2019-08-24T14:15:22Z",
    "approvalDue": "2019-08-24T14:15:22Z",
    "approvedDate": "2019-08-24T14:15:22Z",
    "artworkDue": "2019-08-24T14:15:22Z",
    "quoteDue": "2019-08-24T14:15:22Z",
    "briefCompletionDate": "2019-08-24T14:15:22Z",
    "workCommencesDate": "2019-08-24T14:15:22Z",
    "kickOffMeetingDate": "2019-08-24T14:15:22Z",
    "signOffDate": "2019-08-24T14:15:22Z",
    "executionDate": "2019-08-24T14:15:22Z",
    "crExpirationDate": "2019-08-24T14:15:22Z",
    "kitArrivalDate": "2019-08-24T14:15:22Z",
    "beforeKitArrivalDate": "2019-08-24T14:15:22Z",
    "afterKitArrivalDate": "2019-08-24T14:15:22Z",
    "pickingDate": "2019-08-24T14:15:22Z",
    "stockDestructionBy": "2019-08-24T14:15:22Z",
    "isFinishByIrrelevant": true,
    "isStockDestructionByIrrelevant": true,
    "purchaseOrderNumber": "string",
    "notes": "string",
    "prefix": "string",
    "defaults": {
        "departmentGroup": "retail",
        "fileCopy": 1,
        "oversType": "percent",
        "oversValue": 10,
        "rules": [
            {
                "property": "store",
                "rule": "include",
                "values": [
                    "string"
                ],
                "filters": [
                    {
                        "property": "string",
                        "ids": [
                            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                        ],
                        "values": [
                            "string"
                        ],
                        "rule": "string"
                    }
                ],
                "quantities": [
                    {
                        "property": "string",
                        "values": [
                            "string"
                        ],
                        "amounts": [
                            0
                        ]
                    }
                ]
            }
        ]
    },
    "priceMeta": {
        "packaging": 100.5,
        "delivery": 50.25,
        "additional": 25,
        "discount": 15.75,
        "installation": 200,
        "bumpOut": 75.5
    },
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "ownerPrimary": "4bd8f57a-bed7-4276-88ac-aa3fd0a850c0",
    "itemOwner": "09d72a02-9dae-4cb1-84ef-1ab426e5a067",
    "backupOwner": "ad0103dd-35ef-4f90-b153-0dab69633f73",
    "kitter": "45a23c51-83d5-4e4c-bcae-225a610e896f",
    "templateId": "string",
    "notificationTemplateId": "3528f075-d157-44e3-9447-167c415e2911",
    "notificationTemplateEvents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "isEventDate": true,
            "linkedEventId": "c5b911a2-a3f1-484d-a9a6-eb0d115510b0",
            "sendAtDays": 0,
            "sendNotifications": false,
            "attachSummaryReport": false,
            "recipients": [],
            "subject": "string",
            "message": "string",
            "departments": [],
            "date": "2019-08-24T14:15:22Z",
            "isSent": false,
            "notificationSentAt": "2019-08-24T14:15:22Z"
        }
    ],
    "tradingPeriodIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "campaignItemsEditOnly": true,
    "postFederationAPI": true
}'

Response Example

200 - Example 1

{
    "_id": "550e8400-e29b-41d4-a716-446655440000",
    "clientId": "client123",
    "name": "Q4 Holiday Campaign",
    "number": 2025001,
    "prefix": "HOL",
    "reference": "HOL-2025001",
    "shortReference": "HOL25",
    "status": 100,
    "state": 90,
    "isLocked": false,
    "isActive": true,
    "version": 0,
    "campaignType": [
        "holiday",
        "seasonal"
    ],
    "itemType": "retail",
    "department": [
        "marketing",
        "retail"
    ],
    "region": [
        "north",
        "south"
    ],
    "brand": [
        "brand1",
        "brand2"
    ],
    "priority": "high",
    "season": "Winter 2025",
    "month": "December",
    "year": "2025",
    "startAt": "2025-12-01T00:00:00Z",
    "endAt": "2025-12-31T23:59:59Z",
    "launchDate": "2025-12-15T00:00:00Z",
    "dueInStoreDate": "2025-12-10T00:00:00Z",
    "dispatchBy": "2025-12-08T00:00:00Z",
    "finishBy": "2025-12-05T00:00:00Z",
    "approvalDue": "2025-11-30T00:00:00Z",
    "approvedDate": "2025-11-28T00:00:00Z",
    "artworkDue": "2025-11-25T00:00:00Z",
    "quoteDue": "2025-11-20T00:00:00Z",
    "briefCompletionDate": "2025-11-15T00:00:00Z",
    "workCommencesDate": "2025-11-18T00:00:00Z",
    "kickOffMeetingDate": "2025-11-10T00:00:00Z",
    "signOffDate": "2025-12-20T00:00:00Z",
    "executionDate": "2025-12-12T00:00:00Z",
    "crExpirationDate": "2025-12-31T00:00:00Z",
    "kitArrivalDate": "2025-12-07T00:00:00Z",
    "beforeKitArrivalDate": "2025-12-06T00:00:00Z",
    "afterKitArrivalDate": "2025-12-08T00:00:00Z",
    "pickingDate": "2025-12-09T00:00:00Z",
    "stockDestructionBy": "2026-01-31T00:00:00Z",
    "isFinishByIrrelevant": false,
    "isStockDestructionByIrrelevant": false,
    "lastSentToPrinter": "2025-12-01T00:00:00Z",
    "sentToPrinter": "2025-12-01T00:00:00Z",
    "purchaseOrderNumber": "PO-2025-001",
    "posElementCounter": 0,
    "notes": "Special holiday promotion with extended hours",
    "meta": {},
    "defaults": {
        "departmentGroup": "retail",
        "fileCopy": 1,
        "oversType": "percent",
        "oversValue": 10,
        "rules": [
            {
                "property": "store",
                "rule": "include",
                "values": [
                    "string"
                ],
                "filters": [
                    {
                        "property": "string",
                        "ids": [
                            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
                        ],
                        "values": [
                            "string"
                        ],
                        "rule": "string"
                    }
                ],
                "quantities": [
                    {
                        "property": "string",
                        "values": [
                            "string"
                        ],
                        "amounts": [
                            0
                        ]
                    }
                ]
            }
        ]
    },
    "priceMeta": {
        "packaging": 100.5,
        "delivery": 50.25,
        "additional": 25,
        "discount": 15.75,
        "installation": 200,
        "bumpOut": 75.5
    },
    "elementGroups": [
        {
            "elementId": "550e8400-e29b-41d4-a716-446655440000",
            "campaignItems": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string"
                }
            ]
        }
    ],
    "assetGroups": [
        {
            "assetId": "550e8400-e29b-41d4-a716-446655440000",
            "campaignItems": [
                {
                    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
                    "name": "string"
                }
            ]
        }
    ],
    "notificationTemplateEvents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "isEventDate": true,
            "linkedEventId": "c5b911a2-a3f1-484d-a9a6-eb0d115510b0",
            "sendAtDays": 0,
            "sendNotifications": false,
            "attachSummaryReport": false,
            "recipients": [],
            "subject": "string",
            "message": "string",
            "departments": [],
            "date": "2019-08-24T14:15:22Z",
            "isSent": false,
            "notificationSentAt": "2019-08-24T14:15:22Z"
        }
    ],
    "tradingPeriodIds": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "segRuleIdsToGenerate": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "views": {
        "property1": {
            "property1": "2019-08-24T14:15:22Z",
            "property2": "2019-08-24T14:15:22Z"
        },
        "property2": {
            "property1": "2019-08-24T14:15:22Z",
            "property2": "2019-08-24T14:15:22Z"
        }
    },
    "ziflowFolderId": "ziflow-folder-123",
    "templateId": "template-123",
    "kittingId": "550e8400-e29b-41d4-a716-446655440000",
    "notificationTemplateId": "550e8400-e29b-41d4-a716-446655440000",
    "surveyId": "550e8400-e29b-41d4-a716-446655440000",
    "campaignItemsEditOnly": false,
    "isGeneratingItems": false,
    "postFederationAPI": false,
    "owner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "ownerPrimary": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "createdBy": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "itemOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "backupOwner": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "firstName": "string",
        "lastName": "string",
        "email": "user@example.com"
    },
    "kitter": {
        "_id": "1f704bc5-5055-43eb-a851-c87b6b0bf7b9",
        "name": "string",
        "email": "user@example.com",
        "contact": "string"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T10:00:00Z"
}

Modified at 2025-09-25 10:06:49

Create a new campaign

Delete a campaign