Campaign Builder API
  1. Export
Campaign Builder API
  • Campaign
    • Create a new campaign
      POST
    • Update an existing campaign
      PATCH
    • Delete a campaign
      DELETE
    • List campaigns with filtering and pagination
      GET
    • Simple campaign listing
      GET
    • Get a single campaign
      GET
  • Campaign Bulk Operations
    • Archive multiple campaigns
      POST
  • Booking
    • Create new booking
      POST
    • Update booking
      PATCH
    • Create segmentation rule for booking
      POST
    • Get single booking by ID
      GET
    • Confirm booking
      POST
    • Get booking assets with pagination
      GET
    • Update asset status for booking
      PATCH
    • Update booking segmentation
      POST
    • Refresh booking segmentation
      POST
    • Export booking locations as CSV
      GET
  • Booking Campaign Integration
    • Associate campaigns with booking
      PATCH
    • Remove campaign from booking association
      POST
  • Entity Management
    • Create new entity
      POST
    • Update entity
      PATCH
    • Get single entity
      GET
    • Get entity statistics
      GET
    • Duplicate entities
      POST
    • Archive entities
      PATCH
    • Restore archived entities
      PATCH
  • Campaign Management
    • Publish a campaign
    • Send campaign preview email
  • Campaign Statistics
    • Get campaign statistics
  • Campaign Reports
    • Get available reports for a campaign
  • Campaign Pricing
    • Get campaign item pricing information
  • Campaign Asset Management
    • Get campaign item overview
    • Get priority allocations for a campaign item
    • Update priority allocations for a campaign item
  • Campaign Import
    • Export
      • Duplicate an existing campaign
      • Import artwork files for campaign items
  • Campaign Items
    • Create a new campaign item
    • Get a single campaign item
    • Update a campaign item
    • Delete a campaign item
    • List campaign items
    • Create multiple campaign items
    • Get MOS information for a campaign item
    • Delete MOS information for a campaign item
  • Campaign Items Import
    • Export
      • Export campaign items as CSV
        GET
      • Import campaign items from structured data
        POST
  • Campaign Artwork
    • Create campaign artworks in bulk
    • List campaign artworks with filtering
    • Update an existing campaign artwork
  • Campaign Artwork Management
    • Assign artworker to multiple campaign artworks
    • Cancel multiple campaign artworks
    • Duplicate multiple campaign artworks
    • Remove multiple campaign artworks
  • Schemas
    • Schemas
      • User
      • Task
      • TaskListResponse
      • ErrorResponse
      • TaskCreateRequest
      • TaskResponse
      • TaskUpdateRequest
      • UserTasksResponse
      • TaskAssignRequest
      • Opportunity
      • OpportunityResponse
      • OpportunityUpdateRequest
      • OpportunityListResponse
      • OpportunityCreateRequest
      • OpportunityTier
      • OpportunityTierResponse
      • OpportunityTierUpdateRequest
      • OpportunityTierCreateRequest
      • OpportunityTierListResponse
      • OpportunityTierAsset
      • OpportunityTierAssetResponse
      • OpportunityTierAssetUpdateRequest
      • OpportunityTierAssetCreateRequest
      • OpportunityTierAssetListResponse
      • EntityInstanceFormBase
      • EntityInstanceFormResponse
      • EntityInstanceFormUpdate
      • EntityInstanceFormCreate
      • FormGroupBase
      • FormGroupResponse
      • FormGroupCreate
      • FormGroupUpdate
      • FormFieldLabel
      • FormFieldOption
      • FormFieldIntegrationConfig
      • FormFieldLinkFilter
      • FormFieldBase
      • FormFieldResponse
      • FormFieldCreate
      • FormFieldUpdate
      • EntityInstanceFormSubmissionCreate
      • EntityInstanceFormSubmissionResponse
      • EntityInstanceFormConfigResponse
      • EntityInstanceFormSubmissionFull
      • Advertiser
      • AdvertiserListResponse
      • AdvertiserCreateRequest
      • AdvertiserResponse
      • AdvertiserUserEntity
      • AdvertiserUserBatchListResponse
      • AdvertiserUpdateRequest
      • AdvertiserUser
      • AdvertiserUserListResponse
      • AdvertiserInvite
      • AdvertiserInviteListResponse
      • AdvertiserInviteCreateRequest
      • AdvertiserInviteResponse
      • BulkAssociationCreateRequest
      • OpportunityAdvertiserAssociation
      • BulkAssociationCreateResponse
      • OpportunityAdvertiserUser
      • OpportunityAdvertiser
      • OpportunityAdvertiserListResponse
      • OpportunityAdvertiserUsersResponse
      • DeleteResponse
      • UnavailableAssetMapping
      • BookingUpdateResponse
      • BookingResponse
      • OpportunityAcceptanceResponse
      • OpportunityAcceptanceDetails
      • OpportunityAcceptanceListResponse
      • OpportunityAcceptanceRequest
      • OpportunityAcceptanceResult
      • FormTemplate
      • FormTemplateResponse
      • FormTemplateListResponse
      • FormTemplateCreateRequest
      • FormTemplateUpdateRequest
      • FormTemplateField
      • FormTemplateGroup
      • FormTemplateConfigResponse
      • FormTemplateGroupListResponse
      • FormTemplateGroupCreateRequest
      • FormTemplateGroupUpdateRequest
      • FormTemplateFieldListResponse
      • FormTemplateFieldCreateRequest
      • FormTemplateFieldUpdateRequest
      • FormTemplateFieldMoveGroupRequest
      • SegmentationRuleFilter
      • SegmentationRuleFilterGroup
      • SegmentationRuleNestedFilterGroup
      • SegmentationRuleRules
      • SegmentationRuleItem
      • SegmentationRuleCreate
      • BookingCreate
      • BookingSegmentationRuleRequest
      • BookingErrorResponse
      • BookingAssetResponse
      • BookingAssetListResponse
      • AssetStatusUpdateRequest
      • AssetStatusUpdateResponse
      • BookingUpdateRequest
      • LocationExportResponse
      • CampaignAllocationRule
      • CampaignDefaults
      • CampaignPriceMeta
      • CampaignNotificationEvent
      • CampaignCreateRequest
      • CampaignStatus
      • CampaignState
      • CampaignElementGroup
      • CampaignAssetGroup
      • Campaign
      • CampaignListResponse
      • CampaignUpdateRequest
      • CampaignItemStatus
      • CampaignItemAllocationRule
      • CampaignItem
      • CampaignItemCreateRequest
      • CampaignItemUpdateRequest
      • CampaignItemListResponse
      • CampaignArtworkCategoryGroup
      • CampaignArtworkTargetAsset
      • CampaignArtwork
      • CampaignArtworkListResponse
      • CampaignArtworkUpdateRequest
      • FormPage
      • FormGroupWithFields
      • FormPageResponse
      • FormPageUpdateRequest
      • FormPageListResponse
      • PageConfigResponse
      • FieldValuesResponse
      • FieldValueOption
      • SearchableFieldValue
      • SearchableValuesResponse
      • FormGroupCreateRequest
      • FormGroupUpdateRequest
      • FieldReorderRequest
      • FieldReorderResponse
      • BatchFieldOperation
      • BatchFieldOperationResponse
      • EntityCreateRequest
      • EntityResponse
      • EntityUpdateRequest
      • EntityStatisticsResponse
      • EntityDuplicationRequest
      • EntityDuplicationResponse
      • EntityBulkOperationRequest
      • EntityBulkOperationResponse
  1. Export

Import campaign items from structured data

POST
/campaign-items/{id}/import
Imports campaign items and associated item data into a specified campaign.
Import Process:
Validates all element product codes exist
Creates or updates Item entities based on provided data
Creates CampaignItem entities linking items to the campaign
Handles artwork creation and association
Processes custom fields and metadata
Validates user assignments and ownership
Data Validation:
All element product codes must exist in the system
User references (owner, backupOwner) must be valid
Tag names are validated and created if necessary
Date fields are properly formatted and validated
Artwork data is validated for proper structure
Business Rules:
Campaign must exist and be accessible
User must have permission to create items in the campaign
Element product codes must be valid and active
Artwork entities are created as needed
Tags are created if they don't exist
Side Effects:
Creates Item entities for new items
Creates CampaignItem entities linking to campaign
Creates Artwork entities for artwork data
Creates Tag entities for new tag names
Updates campaign modification timestamp

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK
application/json
Campaign items imported successfully
Body

🟠400Bad Request
🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://prod.your-api-server.com/campaign-items/550e8400-e29b-41d4-a716-446655440000/import' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "campaignItemEntities": [
        {
            "id": null,
            "itemPosNumber": "FLY001",
            "meta": {
                "priority": "high"
            }
        },
        {
            "id": null,
            "itemPosNumber": "BAN001",
            "meta": {
                "priority": "medium"
            }
        }
    ],
    "itemEntities": [
        {
            "name": "Promotional Flyer",
            "tags": [
                "marketing",
                "promotional"
            ],
            "posNumber": "FLY001",
            "extraInfo": "A4 size promotional flyer",
            "elementProductCode": "ELE001",
            "artworks": [
                {
                    "id": null,
                    "name": "Flyer Design v1",
                    "link": "https://example.com/artwork1",
                    "providedBy": "Design Team",
                    "creativeVendor": "Creative Co",
                    "printVendor": "Print Shop"
                }
            ],
            "liveFrom": "2025-10-01T00:00:00Z",
            "liveTo": "2025-12-31T23:59:59Z",
            "owner": "john.doe@example.com",
            "backupOwner": "jane.smith@example.com",
            "meta": {
                "category": "print"
            }
        },
        {
            "name": "Store Banner",
            "tags": [
                "signage",
                "display"
            ],
            "posNumber": "BAN001",
            "elementProductCode": "ELE002",
            "artworks": [],
            "owner": "design.team@example.com",
            "meta": {
                "category": "digital"
            }
        }
    ]
}'
Response Response Example
200 - Example 1
{
    "campaignItemIds": [
        "880e8400-e29b-41d4-a716-446655440003",
        "880e8400-e29b-41d4-a716-446655440004"
    ],
    "campaignItemEntities": {
        "880e8400-e29b-41d4-a716-446655440003": {
            "_id": "880e8400-e29b-41d4-a716-446655440003",
            "campaignId": "550e8400-e29b-41d4-a716-446655440000",
            "itemId": "660e8400-e29b-41d4-a716-446655440001",
            "status": 101,
            "qty": 500
        }
    },
    "itemIds": [
        "660e8400-e29b-41d4-a716-446655440001",
        "660e8400-e29b-41d4-a716-446655440002"
    ],
    "itemEntities": {
        "660e8400-e29b-41d4-a716-446655440001": {
            "_id": "660e8400-e29b-41d4-a716-446655440001",
            "name": "Promotional Flyer",
            "posNumber": "FLY001"
        }
    },
    "artworkIds": [],
    "artworkEntities": {},
    "tagIds": [],
    "message": "Campaign items imported successfully"
}
Modified at 2025-09-25 10:04:16
Previous
Export campaign items as CSV
Next
Create campaign artworks in bulk
Built with