KEkevel
Reserved Campaigns

Update reserved campaign

Fully replace an existing reserved campaign with the provided data. All required fields must be provided.

Important: ID handling for flights and ads

  • The campaign id is required and must match the path parameter.
  • Flights and ads with an id: Will be updated in-place if the ID exists.
  • Flights and ads without an id: Will be created as new entities with auto-generated IDs.
  • Existing flights and ads not included in the request: Will be deleted.

This means the PUT operation performs a full replacement of the reserved campaign structure. To preserve existing flights or ads, you must include them in the request with their respective IDs.

put/forecaster/reserved-campaign/{reservedCampaignId}

Request

  • Base URL
    https://api.kevel.co/v1
  • URL
    https://api.kevel.co/v1/forecaster/reserved-campaign/{reservedCampaignId}
  • Auth
    API key in header X-Adzerk-ApiKey

Request body

idinteger

Unique identifier of the reserved campaign. Auto-generated on creation (do not include when creating). Required when updating via PUT.

namestring required

The name of the reserved campaign.

status'reserved' | 'booked'

The status of the campaign:

  • reserved: The campaign is reserved but not yet booked.
  • booked: The campaign has been confirmed and booked so it will not be considered as a reservation in the forecasts.
descriptionstring nullable

An optional description of the reserved campaign.

salesProbabilityWeightinteger required

A weight (0-100) representing the probability that this reserved campaign will convert to a booked campaign.

advertiserAdvertiser required(unresolved $ref)
capTypeCapType (unresolved $ref)
dailyCapAmountDailyCapAmount (unresolved $ref)
lifetimeCapAmountLifetimeCapAmount (unresolved $ref)
frequencyCapFrequencyCap (unresolved $ref)

Response

Normal response, containing the updated JSON object with the reserved campaign, if successful.

Schema required(unresolved $ref)

Changes

No recorded changes to this operation across all 1 revision of this API.