Update Ad Campaign
PATCH/ads/campaigns/:campaignId
Rename, pause or resume a campaign, or change its budget, end date or settings on the channel's console. Send at least one field; settings merge into the current ones. Requires ads.write.
Request and response fields at a glance
- Path parameters:
campaignId(integer, required). - Request body (application/json):
name(string),budgetAmount(number),budgetType(string),status(string),endDate(string or null),settings(object). - 200 response (application/json):
id(string, required),externalId(string, required),name(string, required),brandId(integer, required),brandName(string, required),brandNameAR(string or null, required),brandLogoUrl(string or null, 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(number or null, required),budgetRemaining(number or null, required),monthlyBudgetCap(number or null, required),isSharedBudget(boolean, required),bidGuidance(object or null, required),currency(string, required),spend(number, required),attributedSales(number, required),directAttributedSales(number or null, required),settledRoas(number or null, required),nativeSuccessMetric(object or null, required),belowFloorShare(number or null, required),views(integer or null, required),clicks(integer or null, required),orders(integer or null, required),atc(integer or null, required),ecpc(number or null, required),startDate(string, required),endDate(string or null, required),lastCapturedAt(string, required),consoleUrl(string or null, required),settings(object, required),pairExpectationState(string, required),reports(object, required).