Campaign Builder API
  1. Booking
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
      • Import campaign items from structured data
  • 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. Booking

Create new booking

POST
/booking
Creates a new booking with the specified details.
Business Rules:
Booking name must be unique within the client namespace
Asset IDs must reference valid, available assets
Start date must be before end date
Creator and owners are automatically set from authenticated user
Booking code is auto-generated

Request

Authorization
API Key
Add parameter in header
Authorization
Example:
Authorization: ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201Created
application/json
Booking created successfully
Body

🟠400Bad Request
🟠404Not Found
🟠409Conflict
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://prod.your-api-server.com/booking' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Q2 2024 Campaign",
    "assetIds": [
        "987fcdeb-51a2-43d1-9f12-345678901234",
        "111fcdeb-51a2-43d1-9f12-345678901234"
    ],
    "startDate": "2024-04-01",
    "endDate": "2024-06-30",
    "status": "reserved"
}'
Response Response Example
201 - Successfully created booking
{
    "_id": "789def01-2345-67f8-9012-3456789abcde",
    "name": "Q2 2024 Campaign",
    "code": "BOOK-2024-002",
    "isActive": true,
    "meta": {},
    "assetIds": [
        "987fcdeb-51a2-43d1-9f12-345678901234",
        "111fcdeb-51a2-43d1-9f12-345678901234"
    ],
    "startDate": "2024-04-01T00:00:00.000Z",
    "endDate": "2024-06-30T23:59:59.999Z",
    "status": "reserved",
    "campaignIds": [],
    "tradingPeriodIds": [],
    "categoryFilters": {},
    "unavailableAssetIds": [],
    "creator": {
        "_id": "user-creator-uuid",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john.doe@example.com"
    },
    "owners": [
        {
            "_id": "user-creator-uuid",
            "firstName": "John",
            "lastName": "Doe",
            "email": "john.doe@example.com"
        }
    ],
    "createdAt": "2024-01-02T10:00:00.000Z",
    "updatedAt": "2024-01-02T10:00:00.000Z",
    "updates": []
}
Modified at 2025-09-25 10:04:16
Previous
Archive multiple campaigns
Next
Update booking
Built with