v1

latestOpenAPI 3.1.02026-07-2616636641.7 KB

Update Flights

This lets you update flights.

put/v1/flight/{FlightID}

Path parameters

FlightIDinteger required

This is the ID of the Flight

Query parameters

excludeAdsboolean

If true, the endpoint returns only the flight metadata without ad objects

Request body

Idinteger required

The ID of the Flight

Namestring required

The name of the Flight

StartDateISOstring required

Start date in ISO 8601 format: YYYY-MM-DDTHH:MM:SS.SSSSSSS. You can also just use YYYY-MM-DD

EndDateISOstring

End date in ISO 8601 format: YYYY-MM-DDTHH:MM:SS.SSSSSSS. You can also just use YYYY-MM-DD

NoEndDateboolean

If flight has no specified End Date, set to true

CampaignIdinteger required

The ID of the campaign

PriorityIdinteger required

The ID of the Priority

GoalTypeinteger required

This is the metric that Kevel uses to pace the ads so it hits the desired goal by the end date. Key follows: 1 = Impressions 2 = Percentage 3 = Click 7 = Conversion 8 = Revenue 9 = Daily Revenue 10 = Monthly Revenue. Instructions are here

Impressionsinteger required

The Goal Amount

IsActiveboolean required

Active/inactive state of the flight

IsDeletedboolean

If want to delete, set to true

IsArchivedboolean

Specifies whether flight is archived.

Response

200

Namestring

StartDateISOstring

EndDateISOstring

CampaignIdinteger

PriorityIdinteger

GoalTypeinteger

Impressionsinteger

RateTypeinteger

Priceinteger

CapTypeinteger

DailyCapAmountinteger

LifetimeCapAmountinteger

IsActiveboolean

Keywordsstring

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

IsFreqCapboolean

FreqCapinteger

FreqCapDurationinteger

FreqCapTypeinteger

DontAffectParentFreqCapboolean

IsCompanionboolean

IsNoDuplicatesboolean

IsTrackingConversionsboolean

CanPassbackboolean

PassbackSortOrderinteger

IsArchivedboolean

IsSundayboolean

IsMondayboolean

IsTuesdayboolean

IsWednesdayboolean

IsThursdayboolean

IsFridayboolean

IsSaturdayboolean

IsECPMOptimizedboolean

ECPMOptimizePeriodinteger

ECPMMultipliernumber

FloorECPMnumber

CeilingECPMnumber

DefaultECPMnumber

ECPMBurnInImpressionsinteger

Example response

{
  "Name": "A Different Name",
  "StartDateISO": "2017-05-01T00:00:00.00.0000000",
  "EndDateISO": "2017-12-31T00:00:00.00.0000000",
  "CampaignId": 1234,
  "PriorityId": 1234,
  "GoalType": 1,
  "Impressions": 20000,
  "RateType": 2,
  "Price": 5,
  "CapType": 1,
  "DailyCapAmount": 5000,
  "LifetimeCapAmount": 50000,
  "IsActive": true,
  "Keywords": "exercise",
  "GeoTargeting": [
    {
      "CountryCode": "US",
      "Region": "NC",
      "MetroCode": 560
    }
  ],
  "SiteZoneTargeting": [
    {
      "SiteId": 123,
      "ZoneId": 321
    }
  ],
  "IsFreqCap": true,
  "FreqCap": 2,
  "FreqCapDuration": 10,
  "FreqCapType": 1,
  "DontAffectParentFreqCap": true,
  "IsCompanion": true,
  "IsTrackingConversions": true,
  "CanPassback": true,
  "PassbackSortOrder": 1,
  "IsSunday": true,
  "IsSaturday": true,
  "IsECPMOptimized": true,
  "ECPMOptimizePeriod": 30,
  "ECPMMultiplier": 1.25,
  "FloorECPM": 0.15,
  "CeilingECPM": 0.35,
  "DefaultECPM": 0.28,
  "ECPMBurnInImpressions": 1000,
  "BehavioralTargeting": {
    "onClick": {
      "stopShowingAdsFromFlight": true,
      "stopShowingAdsFromAdvertiser": true,
      "storeCategoriesFromFlightAsInterest": true
    },
    "onConvert": {
      "stopShowingAdsFromFlight": true,
      "stopShowingAdsFromAdvertiser": true,
      "storeCategoriesFromFlightAsInterest": true
    }
  }
}