KEkevel
Reserved Campaigns

Patch 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.

patch/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

namestring

The name of the reserved campaign.

status'reserved' | 'booked'

The status of the campaign.

descriptionstring nullable

An optional description of the reserved campaign.

salesProbabilityWeightinteger

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

capType1 | 2 | 3 | 4 nullable

The type of cap:

  • 1: Impressions
  • 2: Clicks
  • 3: Conversions
  • 4: Revenue
dailyCapAmountinteger nullable

The daily cap amount (based on capType).

lifetimeCapAmountinteger nullable

The lifetime cap amount (based on capType).

Response

Normal response, containing the full 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.