API DocsKnowledge BaseSystem StatusContact SupportContact Sales
API Documentation
  1. Forecast API
  2. Reserved Campaigns

Patch reserved campaign

patch
https://api.kevel.co/v1/forecaster/reserved-campaign/

Partially update one or more fields of a reserved campaign.
Only the provided fields will be updated; other fields remain unchanged.
Note: Array fields (like flights) are not supported in patch operations.

Path Params
integer
required

The reserved campaign ID.

Body Params

A JSON object with one or more of the reserved campaign fields to update.

Schema for partially updating a reserved campaign. All fields are optional. Only the provided fields will be updated, other fields remain unchanged.

string

The name of the reserved campaign.

string
enum

The status of the campaign.

Allowed:
string | null

An optional description of the reserved campaign.

integer
0 to 100

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

advertiser
object

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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months 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 4 months ago