v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Create Advertisers

post/v1/advertiser/

Request body

Titlestring required

The advertiser name

IsActiveboolean required

Whether advertiser is running. Always set to true when creating. Defaults to false.

PlacementLimitinteger

How many placements the advertiser's ads can fill per request

FreqCapinteger

The number of times that you would like the frequency cap to occur. Set-up instructions here

FreqCapDurationinteger

How often the frequency cap should occur. Set-up instructions here

FreqCapTypeinteger

The unit of time you would like frequency capping to occur. Key follows: 1 = Hour 2 = Day 3 = Minute. Set-up instructions here

CapTypeinteger

Advertisers can only budget cap on the revenue metric. Set to CapType = 4. Do not set to 0 - if removing, set to null

DailyCapAmountinteger

The max daily revenue

LifetimeCapAmountinteger

The max lifetime revenue

CustomFieldsJsonstring

Sets the value of custom fields based on a custom fields schema. Must contact support before use. More info here.

RtbCustomFieldsstring

Required for RTB enabled advertisers only. JSON Object in a String. It's JSON data provided by the RTB partner. Certain parameters in the object will be required per partner. If you aren't sure what is required, your account manager will supply you with the data for this property.

ExternalIdstring

Used to reference an ID from another external system

PartnerIdinteger

Required for RTB enabled advertisers only. The ID of the RTB Partner. If you aren't sure what is required, your account manager will supply you with the data for this property.

IsDeletedboolean

Whether advertiser is deleted. Defaults to false

Response

200