v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Update Ad

put/v1/flight/{FlightID}/creative/{AdID}

Path parameters

FlightIDinteger required

The ID of the Flight

AdIDinteger required

This is the ID from the Ad / Creative Flight Map Endpoint. It's not the ID from the Create Creatives endpoint.

Request body

Idinteger required

ID of the Creative Flight Map / Ad

CampaignIDinteger

ID of the Campaign

FlightIDinteger required

ID of the Flight

Creativeobject required

A creative object that contains the ID (id) of the Creative

IsActiveboolean required

If Ad is active or not

IsDeletedboolean required

If Ad is deleted or not

Iframeboolean

Whether Creative should use iFrame

DistributionTypeinteger

Determines how the Ad is distributed within the flight

RtbCustomFieldsstring

Required for RTB ads only. JSON Object in a String. It's JSON data provided by the RTB partner

DontAffectParentFreqCapboolean

"Opts-out" of frequency cap settings imposed on it by entities above

FreqCapinteger

The value of the frequency cap

FreqCapDurationinteger

How long the frequency cap should apply

FreqCapTypeinteger

The unit for the frequency cap: 1 = Hour 2 = Day 3 = Minute.

Response

200

Idinteger

CampaignIdinteger

FlightIdinteger

ZoneIdinteger

SiteIdinteger

Iframeboolean

PublisherAccountIdinteger

Impressionsinteger

Percentageinteger

DistributionTypeinteger

IsDeletedboolean

IsActiveboolean

CustomTargetingstring

FreqCapinteger

FreqCapDurationinteger

FreqCapTypeinteger

{"stackTrail":"paths:/v1/flight/{FlightID}/creative/{AdID}:put:responses:200:content:application/json:schema:properties:StartDate","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/v1/flight/{FlightID}/creative/{AdID}:put:responses:200:content:application/json:schema:properties:EndDate","oasType":"schema","type":"unknown"}

GoalTypeinteger

Goalinteger

Priceinteger

IsGoalOverrideboolean

IsStartEndDateOverrideboolean

ActiveKeywordsstring[]

{"stackTrail":"paths:/v1/flight/{FlightID}/creative/{AdID}:put:responses:200:content:application/json:schema:properties:RtbCustomFields","oasType":"schema","type":"unknown"}

Example response

{
  "Id": 12345,
  "CampaignId": 123,
  "FlightId": 1234,
  "ZoneId": 1234,
  "SiteId": 12345,
  "DistributionType": 1,
  "Creative": {
    "Id": 123456,
    "Title": "Adzerk Blue Creative",
    "Url": "https://adzerk.com",
    "AdvertiserId": 1234,
    "IsActive": true,
    "AdTypeId": 5,
    "Alt": "Adzerk - Native Ads",
    "IsHTMLJS": true,
    "ScriptBody": "Flight Creative Map",
    "ImageLink": "httpss://static.adzerk.net/Advertisers/",
    "IsNoTrack": true
  },
  "CustomTargeting": "$keywords contains \"dean\"",
  "FreqCap": 5,
  "FreqCapDuration": 1,
  "FreqCapType": 2,
  "GoalType": 1,
  "Goal": 20000,
  "Price": 1,
  "IsGoalOverride": true,
  "IsStartEndDateOverride": true,
  "ActiveKeywords": [
    "kittens"
  ]
}