Campaign Builder API
  1. Schemas
Campaign Builder API
  • Campaign
    • Create a new campaign
    • Update an existing campaign
    • Delete a campaign
    • List campaigns with filtering and pagination
    • Simple campaign listing
    • Get a single campaign
  • Campaign Bulk Operations
    • Archive multiple campaigns
  • Booking
    • Create new booking
    • Update booking
    • Create segmentation rule for booking
    • Get single booking by ID
    • Confirm booking
    • Get booking assets with pagination
    • Update asset status for booking
    • Update booking segmentation
    • Refresh booking segmentation
    • Export booking locations as CSV
  • Booking Campaign Integration
    • Associate campaigns with booking
    • Remove campaign from booking association
  • Entity Management
    • Create new entity
    • Update entity
    • Get single entity
    • Get entity statistics
    • Duplicate entities
    • Archive entities
    • Restore archived entities
  • 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. Schemas

FormTemplateConfigResponse

Complete template configuration with nested groups and fields

{
    "_id": "f3330a90-56a0-11f0-83f6-c58e6de49d0a",
    "id": "f3330a90-56a0-11f0-83f6-c58e6de49d0a",
    "title": "Radio Campaign Template",
    "description": "Standard template for radio advertising campaigns",
    "isActive": true,
    "createdAt": "2025-07-01T17:27:58.273Z",
    "updatedAt": "2025-07-01T17:27:58.273Z",
    "__v": 0,
    "groups": [
        {
            "_id": "f3553890-56a0-11f0-83f6-c58e6de49d0a",
            "id": "f3553890-56a0-11f0-83f6-c58e6de49d0a",
            "title": "Campaign Details",
            "description": "Basic campaign information and requirements",
            "formPageId": "f3330a90-56a0-11f0-83f6-c58e6de49d0a",
            "tabName": "Campaign Details",
            "order": 1,
            "isActive": true,
            "createdAt": "2025-07-01T17:27:58.570Z",
            "updatedAt": "2025-07-01T17:27:58.570Z",
            "__v": 0,
            "fields": [
                {
                    "_id": "f3636960-56a0-11f0-83f6-c58e6de49d0a",
                    "id": "f3636960-56a0-11f0-83f6-c58e6de49d0a",
                    "name": "Station Name",
                    "type": "text",
                    "order": 1,
                    "formGroupId": "f3553890-56a0-11f0-83f6-c58e6de49d0a",
                    "formPageId": "f3330a90-56a0-11f0-83f6-c58e6de49d0a",
                    "required": false,
                    "isCore": false,
                    "isActive": true,
                    "isArchived": false,
                    "includeInList": false,
                    "lockedOnEdit": false,
                    "lockedOnCreate": false,
                    "excludeFromExport": false,
                    "excludeFromDuplicate": false,
                    "searchable": false,
                    "statsField": false,
                    "isMultiSelect": false,
                    "shouldHaveLocationStatusDisabled": false,
                    "isUSBankCC": false,
                    "label": [
                        {
                            "text": "Station Name",
                            "locale": "en"
                        }
                    ],
                    "options": [
                        {
                            "label": "Option 1",
                            "value": "option1",
                            "locale": "en"
                        }
                    ],
                    "linkDisplayFields": [
                        "firstName"
                    ],
                    "integrationConfigs": [
                        {}
                    ],
                    "createdAt": "2025-07-01T17:27:58.646Z",
                    "updatedAt": "2025-07-01T17:27:58.646Z",
                    "__v": 0
                }
            ]
        }
    ]
}
Built with