Update Delivery Status of Campaigns
You can update the delivery activation status of campaigns using this PUT operation. You can pause, resume, archive and unarchive campaigns as part of this API operation.
- This API supports batch operations with a max batch size of 10. For bulk operation, the advertiserId must be the same across all requests in the payload.
- advertiserId and campaignId combination should be unique in the request payload
URL: PUT/api/v1/campaigns/action
Request Parameters
| Parameters | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of advertiser whose campaign is to be scheduled | integer | Y | Advertiser ID for which the campaign needs to be updated for delivery status |
| campaignId | ID of the campaign requiring updates to its delivery status | integer | Y | Unique numeric identifier |
| action | Delivery activation status | string | Y | • pause • resume • archive • unarchive |
Sample Request
curl -X PUT \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/campaigns/action' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>'
--header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' -data ' [ { "advertiserId": 1, "campaignId": 1, "action": "pause" }
] ' Sample Request (Batch Operation)
curl -X PUT \ 'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/campaigns/action' \ --header 'Content-Type: application/json' \ --header 'Authorization: Bearer <auth_token>'
--header 'WM_SEC.AUTH_SIGNATURE: **************' \ --header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \ --header 'WM_CONSUMER.intimestamp: 1565309779' -data ' [ { "advertiserId": 1, "campaignId": 1, "action": "pause" }, { "advertiserId": 1, "campaignId": 2, "action": "resume" },
{ "advertiserId": 1, "campaignId": 3, "action": "archive" },
{ "advertiserId": 1, "campaignId": 4, "action": "unarchive " },
] ' Response
| Element | Description | Type |
|---|---|---|
| code | The response code can have following values:
Click here for more information about Status Codes and Errors | string |
| details | Details will populate success or error message depending upon value of code | string |
| campaignId | ID of campaign with recently changed delivery status | integer |
Sample Response
[ { "code": "success", "details": ["string"], "campaignId": 1 }
] Sample Response (Batch Operation)
[ { "code": "success", "details": ["string"], "campaignId": 1 }, { "code": "success", "details": ["string"], "campaignId": 2 }, { "code": "failure", "details": ["string"], "campaignId": 3 }, { "code": "success", "details": ["string"], "campaignId": 4 }
] Updated about 1 month ago