Archive multiple campaigns

POST

/campaigns/archive

Archives multiple campaigns by setting their isActive flag to false.
This is a soft delete operation that hides campaigns from normal listings
but preserves all data for potential restoration.

Business Rules:

All specified campaigns must exist

User must have permission to modify all specified campaigns

Campaigns must not be locked

This is a transactional operation (all or nothing)

Side Effects:

Sets isActive to false for all specified campaigns

Increments version number for each campaign

Updates modification timestamp for each campaign

Triggers notifications for each campaign

Logs archive operation for audit purposes

Transaction Behavior:

If any campaign fails to archive, the entire operation is rolled back

Validates all campaigns before making any changes

Provides detailed error information for failed operations

Request

Authorization

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Campaigns archived successfully

Body

🟠400Bad Request

🟠403Forbidden

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://prod.your-api-server.com/campaigns/archive' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignIds": [
        "550e8400-e29b-41d4-a716-446655440000",
        "550e8400-e29b-41d4-a716-446655440001",
        "550e8400-e29b-41d4-a716-446655440002"
    ]
}'

Response Example

200 - Example 1

{
    "success": true,
    "archivedCount": 0,
    "archivedCampaigns": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "errors": [
        {
            "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
            "error": "string",
            "message": "string"
        }
    ]
}

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

Get a single campaign

Create new booking