Skip to content

Campaigns API Endpoints

About Campaigns

Campaign - A Campaign is a container for Creatives (via their Inventory Item Objects). Campaigns are assigned to an Account and can be assigned to one or more Digital Boards.

Property Value
Can Create Yes
Can Delete Yes

Key Features

  • Container for creatives (via Inventory Items)
  • Assigned to an account
  • Can be assigned to one or more digital boards
  • Controls when and where creatives are displayed

Endpoints

Method Endpoint Description
GET /api/v3/campaigns GET campaigns
POST /api/v3/campaigns POST campaigns
GET /api/v3/campaigns/constants/build-statuses GET /campaigns/constants/build-statuses
GET /api/v3/campaigns/constants/campaign-classes GET /campaigns/constants/campaign-classes
GET /api/v3/campaigns/constants/campaign-states GET /campaigns/constants/campaign-states
GET /api/v3/campaigns/extensions/apx/{apxContractId} GET campaigns/extensions/apx/{getApxContractId}
GET /api/v3/campaigns/extensions/px/{pxDealId} GET campaigns/extensions/px/{pxDealId}
GET /api/v3/campaigns/extensions/vistar/{vistarInsertionOrderId} GET campaigns/extensions/vistar/{vistarInsertionOrderId}
GET /api/v3/campaigns/extensions/watchfire/campaigns GET /v3/campaigns/extensions/watchfire/campaigns
GET /api/v3/campaigns/{lcuid} GET campaigns/{id}
PUT /api/v3/campaigns/{lcuid} PUT campaigns/{id}
GET /api/v3/campaigns/{lcuid}/digital-boards GET campaigns/{lcuid}/digital-boards
PUT /api/v3/campaigns/{lcuid}/digital-boards PUT campaigns/{lcuid}/digital-boards
DELETE /api/v3/campaigns/{lcuid}/digital-boards/{id} DELETE campaigns/{lcuid}/digital-boards/{id}
GET /api/v3/campaigns/{lcuid}/inventory-items GET campaigns/{lcuid}/inventory-items
PUT /api/v3/campaigns/{lcuid}/inventory-items PUT campaigns/{lcuid}/inventory-items
DELETE /api/v3/campaigns/{lcuid}/inventory-items/{id} DELETE campaigns/{lcuid}/inventory-items/{id}
PUT /api/v3/campaigns/{lcuid}/inventory-items/{id}/board-filter PUT campaigns/{lcuid}/inventory-items/{id}/board-filter
PUT /api/v3/campaigns/{lcuid}/inventory-items/{id}/digital-boards PUT campaigns/{lcuid}/inventory-items/{id}/digital-boards
GET /api/v3/campaigns/{lcuid}/pull/{boardIdentifier} GET campaigns/{id}/pull/{boardIdentifier}

← Back to Main Index