Campaigns Put Api202301External Campaign By Campaign Id
PUT {{baseUrl}}/2024-07/retail-media/campaigns/:campaignId
Edit a campaign for the given campaign id with a given editable attributes. This will return updated creatable and editable attributes of the campaign as the result of the operation. Pacing can be adjusted and affected by the status of the campaign and the days left on the campaign if auto daily pacing is enabled.
Request Body
{"data"=>{"id"=>"<string>", "type"=>"<string>", "attributes"=>{"name"=>"<string>", "isAutoDailyPacing"=>"<boolean>", "startDate"=>"<dateTime>", "endDate"=>"<dateTime>", "clickAttributionWindow"=>"7D", "viewAttributionWindow"=>"FourteenDays", "budget"=>"<number>", "monthlyPacing"=>"<number>", "dailyPacing"=>"<number>", "clickAttributionScope"=>"unknown", "viewAttributionScope"=>"unknown", "companyName"=>"<string>"}}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"data":{"id":"\u003cstring\u003e","type":"\u003cstring\u003e","attributes":{"accountId":"\u003cstring\u003e","promotedBrandIds":["\u003cstring\u003e","\u003cstring\u003e"],"budgetSpent":"\u003cnumber\u003e","budgetRemaining":"\u003cnumber\u003e","createdAt":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","name":"\u003cstring\u003e","isAutoDailyPacing":"\u003cboolean\u003e","startDate":"\u003cdateTime\u003e","endDate":"\u003cdateTime\u003e","status":"inactive","type":"auction","drawableBalanceIds":["\u003cstring\u003e","\u003cstring\u003e"],"clickAttributionWindow":"30D","viewAttributionWindow":"None","budget":"\u003cnumber\u003e","monthlyPacing":"\u003cnumber\u003e","dailyPacing":"\u003cnumber\u003e","clickAttributionScope":"sameSkuCategory","viewAttributionScope":"sameSkuCategory","companyName":"\u003cstring\u003e"}},"errors":[{"traceId":"\u003cstring\u003e","type":"validation","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"etc":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"quota","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"laborum2":"\u003cstring\u003e","proident_999":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}],"warnings":[{"traceId":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"ex_f":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"},{"traceId":"\u003cstring\u003e","type":"authorization","code":"\u003cstring\u003e","instance":"\u003cstring\u003e","title":"\u003cstring\u003e","detail":"\u003cstring\u003e","source":{"inc1":"\u003cstring\u003e","ex36":"\u003cstring\u003e"},"stackTrace":"\u003cstring\u003e"}]}