Campaign API
Campaigns
Campaigns are a grouping of bookings and their associated creatives.
Create a Campaign
POST /v1/campaigns
Creates a new campaign.
Request body - CreateCampaignDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Display name of the company. |
advertiserId | integer | No | ID of the advertiser/media partner you want to attach to this campaign. |
brandIdsintegerNoIDs of the brands you want attached to this campaign.externalKeystringNoYour own external reference key.frequencyLimitsinteger, stringNoFrequency limit settings for the campaign.- amountintegerNoLimit of event per set period per scope.- eventstringNoSet the limit to either IMPRESSIONS or CLICKS.- periodstringNoPeriod for which the amount is applied as limit to the event. Either DAILY or HOURLY.- scopestringNoOn which level the limit is applied. In this case always CAMPAIGN.priorityIdintegerYesPriority of the campaign. 0 is the highest priority, with higher numbers representing lower priorities. By default clients have priorities 0 through 4 configured.campaignTypestringYesCampaign type is either FULL for managed campaigns and, GUARANTEED or AUCTIONED for Self Service. In case of doubt with Self Service, pick GUARANTEEDreservationTypestringYesType of the campaign, either CAMPAIGN, OFFER, Option or DRAFT in the case of an Advendio campaigndeliveryFactorsinteger, stringNoCampaign goals expressed involume of unit, or in budget