Home
API Reference

Create a new flight

post
https://example.com/app-api/campaign//flight
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

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

Body Params
runtime
object
required

Start and Enddate of the flight

integer
required

Corresponds with the field "Tarif"

integer
required

Corresponds with the field "Medium"

integer

Corresponds with the field "Extra Preis Ebene"

integer
required

Corresponds with the field "Platform"

integer
required

Corresponds with the field "Channel"

integer
required

Corresponds with the field "Werbemittel"

integer
required

Corresponds with the field "Preistyp"

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.

integer
required

Corresponds with the field "Anzahl Einheiten"

required

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)

string
enum

Corresponds with the field "WM Status"

Allowed:
string

Corresponds with the field "Bemerkungen"

string

Corresponds with the field "Interne Bemerkungen"

string

Corresponds with the field "Faktura Bemerkungen"

string
required

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"

string
required
Responses
201

Flight has been created

400

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

  • 1f06b2d7-49b4-4b8b-aa66-5172aeb01e97 - The externalId is already in use
  • 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
  • 3d3b78ef-1595-47a3-b85d-20a5ee9a873c - Flight is already fully invoiced
404

The campaign does not exist

Updated about 2 months ago

Language
LoadingLoading…
Response
Choose an example:
application/json

Updated about 2 months ago