API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation

Update reserved campaign

put
https://api.kevel.co/v1/forecaster/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.

Path Params
integer
required

The reserved campaign ID.

Body Params

The JSON object with the complete reserved campaign data.

integer

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

string
required

The name of the reserved campaign.

string
enum
Defaults to reserved

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.
Allowed:
string | null

An optional description of the reserved campaign.

integer
required
0 to 100

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

advertiser
object
required

The advertiser associated with the reserved campaign.

integer | null
enum

The type of cap:

  • 1: Impressions
  • 2: Clicks
  • 3: Conversions
  • 4: Revenue
Allowed:
integer | null

The daily cap amount (based on capType).

integer | null

The lifetime cap amount (based on capType).

frequencyCap
object | null

Configuration for limiting ad frequency to users.

flights
array of objects
required
length ≥ 1

The flights associated with this reserved campaign. At least one flight is required.

flights*
integer

Unique identifier of the flight. Auto-generated on creation (do not include when creating). When updating via PUT: include to update in-place, omit to create as new.

integer
required

The ID of the priority level for this flight.

rate
object
required

The rate configuration for billing.

string | null

Keyword targeting rules. Please head to Keyword Logic for more details.

siteZoneTargeting
array of objects | null
siteZoneTargeting
geoTargeting
array of objects | null
geoTargeting
distanceTargeting
array of objects | null
distanceTargeting
string | null

A string for custom targeting using the Zerkel Language.

integer | null
enum

When defined, enables no duplicates and defines the type of the duplicate mode:

  • 1: Flight
  • 2: Campaign
  • 3: Advertiser
  • 4: Creative
Allowed:
ads
array of objects
required
length ≥ 1

The ads associated with this flight. At least one ad is required.

ads*
integer

Unique identifier of the ad. Auto-generated on creation (do not include when creating). When updating via PUT: include to update in-place, omit to create as new.

integer
required

The ad type ID.

segmentTargeting
array of objects | null

Segment-based audience targeting.

segmentTargeting
date-time
required

The start date and time of the flight.

date-time | null

The end date and time of the flight. Required for goal types other than Percentage (2), Daily Revenue (9), or Monthly Revenue (10). Must be after the start date and after the current date.

string
Defaults to UTC

The time zone for the flight's schedule.

integer
enum
required

The type of goal for this flight:

  • 1: Impressions
  • 2: Percentage
  • 3: Clicks
  • 7: Conversions
  • 8: Revenue
  • 9: Daily Revenue
  • 10: Monthly Revenue
Allowed:
integer
required

The target amount for the goal (e.g., number of impressions, percentage, etc.).

integer | null
enum

The type of cap:

  • 1: Impressions
  • 2: Clicks
  • 3: Conversions
  • 4: Revenue
Allowed:
integer | null

The daily cap amount (based on capType).

integer | null

The lifetime cap amount (based on capType).

frequencyCap
object | null

Configuration for limiting ad frequency to users.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated about 1 month ago