post
https://sandbox-api.viantinc.com/{basePath}/campaign
Creates a campaign.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Note
io_number and externalCampaignId both serve the same purpose and refer to the same value: an external ID for use by clients. These fields point to the same value; on input, a caller should use one field or the other, not both; on output, both fields are provided (currently), and will have the same value.
Request
POST /campaign/save
Request Body
| Name | Type | Description | Required |
|---|---|---|---|
| id | Number | Campaign ID. | Required for update. |
| advertiserId | Number | Advertiser ID associated with the campaign. | Yes |
| name | String | Campaign name. | Yes |
| domain | String | The advertiser domain for the campaign (e.g. viant.com). | Yes |
| maxBudget | Number | Total lifetime budget for the campaign in USD. | Yes |
| dailyBudget | Number | Maximum daily spend in USD. | No |
| dailyFrequencyCap | Number | The maximum number of impressions a user is exposed to per frequency cap time period duration. Note: The name of this field is misleading since it is not necessarily "daily". The name of this field remains unchanged for backwards compatibility and will be updated on the next major version. See frequencyCapDuration and frequencyCapTimePeriod. | Yes (if frequencyCapDuration or frequencyCapTimePeriod present) |
| frequencyCapDuration | Number | The number of given frequencyCapTimePeriod. | Yes (if dailyFrequencyCap or frequencyCapTimePeriod present) |
| frequencyCapTimePeriod | String | "MINUTE", "HOUR", "DAY" | Yes (if dailyFrequencyCap or frequencyCapDuration present) |
| startDate | Number | Start date (Unix time in milliseconds). | Yes |
| endDate | Number | End date (Unix time in milliseconds). | Yes |
| iabCategory | String Array | An array of IAB category codes (e.g. "IAB8-6"). See reference table here | Yes |
| markupRate | Number | Markup as a decimal (e.g. 0.10 for 10%). | No |
| lifetimeImpressionCap | Number | Lifetime impression cap. | No |
| dailyImpressionCap | Number | Daily impression cap. | No |
| lifetimeClickCap | Number | Lifetime click cap. | No |
| dailyClickCap | Number | Daily click cap. | No |
| ioNumber | String | IO Number. Used as client ID; mutually exclusive with externalCampaignId. | No |
| externalCampaignId | String | Client campaign ID; mutually exclusive with ioNumber. | No |
| minBidMultiplier | Number | Minimum bid multiplier. | No |
| maxBidMultiplier | Number | Maximum bid multiplier. | No |
| flights | Object Array | Array of campaign flights. | Yes for campaign flights, No for order flights |
| autoAdvertising | Boolean | Whether Viant AI is enabled for this campaign. | No |
| pacingMode | String | One of: ASAP, SPEND_EVENLY | No |
| intradayFrontloadPct | Number | Increase hourly budget to frontload spend. | No |
| objective | String | One of: AWARENESS, ENGAGEMENT, CONVERSION | No |
Unauthorized
Forbidden
Not Found