Campaign Builder API
  1. Campaign Items
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
    • 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
      POST
    • Get a single campaign item
      GET
    • Update a campaign item
      PATCH
    • Delete a campaign item
      DELETE
    • List campaign items
      GET
    • Create multiple campaign items
      POST
    • Get MOS information for a campaign item
      GET
    • Delete MOS information for a campaign item
      DELETE
  • 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. Campaign Items

Delete MOS information for a campaign item

DELETE
/campaign-item/{id}/mos-information
Removes MOS information and related custom field data from a campaign item.
What Gets Deleted:
All custom field values mapped from federation API responses
mosInfoSynced flag from meta object
Custom attributes mapped via responseElement integrations
Business Rules:
Only removes fields that have responseElement integration configs
Preserves other custom field values not related to MOS
Updates the campaign item's updatedAt timestamp
Use Cases:
Reset MOS information to force fresh fetch from federation API
Clear stale or incorrect MOS data
Troubleshooting integration issues

Request

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

Responses

🟢200OK
application/json
MOS information deleted successfully
Body

🟠404Not Found
🔴500Internal Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://prod.your-api-server.com/campaign-item/880e8400-e29b-41d4-a716-446655440003/mos-information' \
--header 'Authorization: <api-key>'
Response Response Example
200 - MOS information and custom fields cleared
{
    "_id": "880e8400-e29b-41d4-a716-446655440003",
    "clientId": "client123",
    "campaignId": "550e8400-e29b-41d4-a716-446655440000",
    "itemId": {
        "_id": "660e8400-e29b-41d4-a716-446655440001",
        "name": "Promotional Flyer",
        "posNumber": "FLY001"
    },
    "status": 102,
    "qty": 500,
    "mosInformation": {},
    "meta": {
        "preservedCustomField": "This field remains"
    },
    "createdAt": "2025-09-09T10:00:00Z",
    "updatedAt": "2025-09-09T16:30:00Z"
}
Modified at 2025-09-25 10:04:16
Previous
Get MOS information for a campaign item
Next
Export campaign items as CSV
Built with