Update a campaign

post

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

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

Notice that when changing the customer, it will apply the new customer discounts automatically.

When changing or setting agency/intermediator, by default, commissions will be set to the values found in the agency/intermediator again. Even if the commission was set on the flight. Updating agency/intermediator to null will, by default, set the commissions to 0 and the commissionStatus as well to 0.

When agency/intermediator are sent in the body and you don't want to update the commissions you can use the query parameter update_commissions=0.

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

Query Params

update_commissions

boolean

enum

Defaults to 1

Whether to update commissions or not

0: commissions will not be updated and stay the same even if agency and/or intermediator are changed. Flights created hereafter will use the old commissions.
1: commissions will be updated only if the payload as well has values set for the intermediator or agency. Flights created hereafter will always use those commissions as well. If you have set custom flight commissions manually on flights, they will be reset to the values of the agency/intermediator.

Allowed:

Body Params

A goTom campaign

name

string

Corresponds with the field "Kampagne"

status

string

enum

Defaults to booking

Corresponds with the field "Status"

Allowed:

bookingDate

date

Corresponds with the field "Buchungsdatum"

campaignTypeId

integer

Corresponds with the field "Kampagnentyp"

campaignTypeReference

string

Corresponds with the field "Kampagnentyp Referenz"

customer

object | null

This entity represents either a customer, agency, intermediator or publisher, either the external ID or the external CRM ID or the goTom ID can be set

intermediator

object | null

This entity represents either a customer, agency, intermediator or publisher, either the external ID or the external CRM ID or the goTom ID can be set

agency

object | null

This entity represents either a customer, agency, intermediator or publisher, either the external ID or the external CRM ID or the goTom ID can be set

note

string | null

Corresponds with the Field "Bemerkungen"

noteInternal

string

Corresponds with the Field "Interne Bemerkungen"

noteReservation

string

Corresponds with the Field "Reservationsabklärung"

pdfInvoiceWithAttachment

boolean

Defaults to true

Corresponds to the "Dokumente" field. If true, the invoice will be created with an appendix e.g. the Order Confirmation; if false, it will be created without one, as default it would be true.

billingType

integer

enum

Corresponds with the field "Billing type" / "Abrechnungsart" on the "Invoicing" / "Billing type" view of the campaign. Use this value only if you want to explicitly define the billing type of the campaign. You can safely omit this value to let goTom apply the rules for finding the right billing type for this campaign. Billing type possible values and their meaning:

0 - Custom - The user must explicitly set up the invoices and assign flights
1 - End / Nach Ablauf - All flights are automatically assigned to one invoice
2 - Monthly to daily value / Monatlich nach Tageswert - Automatic assignment on a monthly basis, distributed by time
3 - Monthly to delivery value / Monatlich nach Lieferwert - Automatic assignment on a monthly basis, distributed by delivery value

Please note, that your instance may not support all values. If your instance does not have an ad-server integration the value for "Monthly to delivery value" can't be used. If you use a value that is not supported by your instance, you will get an API error (code 7e44e734-3535-4172-8e32-0efa8b33a5e0) with the list of the possible values for your instance. If the campaign has at least one invoice that has already been invoiced it is also not possible to change this value to something different. If this is the case you will get the API error code 43452cb6-8850-4036-b1f5-971c8328e10b and none of the updates in the payload will be applied.

Allowed:

salesSupportId

integer

Correspons with the field "Innendienst". Only salesSupportId or salesSupportEmail should be provided.

salesSupportEmail

string

Correspons with the field "Innendienst". Only salesSupportId or salesSupportEmail should be provided.

salesId

integer

Corresponds with the field "Verkauf". Only salesId or salesEmail should be provided.

salesEmail

string

Corresponds with the field "Verkauf". Only salesId or salesEmail should be provided.

Responses

204

Campaign has been updated

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