Skip to main content

Update an advertising campaign

PATCH 
/v1/ads/campaigns/:campaignId

Update supported campaign fields. Operator-set status is limited to Live or Paused; omitted fields retain their current values.

Request and response fields at a glance
  • Path parameters: campaignId (string, required).
  • Request body (application/json): name (string), budgetAmount (number), budgetType (string), status (string), endDate (mixed), settings (object).
  • 200 response (application/json): id (string, required), name (string, required), brandId (number, required), brandName (string, required), saleChannel (object, required), nativeTypeName (string, required), family (string, required), objective (string, required), costModel (string, required), status (string, required), targeting (string, required), budgetType (string, required), budgetAmount (number, required), budgetSpent (mixed, required), budgetRemaining (mixed, required), monthlyBudgetCap (mixed, required), sharedBudget (boolean, required), bidGuidance (mixed, required), spend (number, required), attributedSales (number, required), directAttributedSales (mixed, required), settledRoas (mixed, required), nativeSuccessMetric (mixed, required), belowFloorShare (mixed, required), views (mixed, required), clicks (mixed, required), orders (mixed, required), atc (mixed, required), ecpc (mixed, required), startDate (string, required), endDate (mixed, required), lastCapturedAt (string, required), consoleUrl (mixed, required), settings (object, required), estimatedMissedSales (number), pairExpectationState (string).

Request​