Update the flight

post

https://example.com/app-api/campaign/{campaignExternalId}/flight/{flightExternalId}

Update the flight. All the properties are optional, only the supplied properties are changed.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

campaignExternalId

string

required

External ID of a campaign. See: Good and Bad External IDs

flightExternalId

string

required

External ID of a flight. See: Good and Bad External IDs

Body Params

A goTom Flight

runtime

object

Start and Enddate of the flight

tarifId

integer

Corresponds with the field "Tarif"

mediaId

integer

Corresponds with the field "Medium"

extraPriceLevelId

integer

Corresponds with the field "Extra Preis Ebene"

platformId

integer

Corresponds with the field "Platform"

channelId

integer

Corresponds with the field "Channel"

advertisingId

integer

Corresponds with the field "Werbemittel"

priceTypeId

integer

Corresponds with the field "Preistyp"

flightPositionTypeName

string | null

The flightPositionTypeName, which can be retrieved via the primary key endpoint. Note that even when this value is set to null, the application may use a default value, as shown in the primary key endpoint.

If no value is set, the read response will include the default flightPositionTypeName. Therefore, setting this field to null causes the flight to fall back to the default value.

units

integer

Corresponds with the field "Anzahl Einheiten"

bruttoPriceUnit

Corresponds with the field "Finaler Bruttopreis Einheit". Can be a number (ie 15.20), or the string "loadFromRate" (will autoload the price from the rate sheet). Can be omitted when updating a flight (existing bruttoPriceUnit will stay the same)

advertisingStatus

string

enum

Corresponds with the field "WM Status"

Allowed:

note

string

Corresponds with the field "Bemerkungen"

noteInternal

string

Corresponds with the field "Interne Bemerkungen"

noteBilling

string

Corresponds with the field "Faktura Bemerkungen"

adServerId

string

Corresponds with the field "AdServer"

keyValueSets

array of objects

Corresponds with the field "Targeting Configuration -> Key / Values"

keyValueSets

geoTargetingByZip

object

Corresponds with the field "Targeting Configuration -> Geo Targeting -> PLZ"

flightTags

array of integers

Tags of the flight. Corresponds with the "Flight Tags" Field in the UI of the "Umsatzarten" / "Revenue Types" campaign view When creating/updating only the array with IDs are expected, send null or an empty array to clear the tags on update.

flightTags

keyValueSetsXandr

array of objects

Xandr key-value targeting result set. Used for both read and write operations.

keyValueSetsXandr

adServerPushChanges

object

Responses

204

Flight has been updated

400

Returns a list of errors in the input data. For this call the following violation codes can be expected

5658b9ca-ce50-4a98-a0da-97d9361845e3 - An invalid ID field has been given (for example the platformId in the customer object could not be found), here you have to refer to the propertyPath value to find out which property caused the error
e3a1d7f7-4fcf-4b7d-8d87-38a60126462f - The combination of platformId, channelId and advertisingId does not exist
409d70bf-376e-4a21-a8d0-f75a4a6a7abc - There is no price entry found for the combination of platformId, channelId, advertisingId, tarifId, extraPriceLevelId and priceTypeId does not exist
24a9375a-0b22-4676-9a29-9c9e7f2c195f - The adServerId provided in the KeyValueSet is invalid

404

The campaign does not exist

500If your request broke our code. Send us your request-document to reproduce the error and we'll fix it.