Update delivery status for Ad Groups
URL: PUT/api/v1/adGroups/action
Note: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
Request Parameters
| Parameters | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of advertiser | integer | Y | Advertiser ID for which the ad group needs to be updated for delivery status |
| adGroupId | ID of the ad group requiring updates to its delivery status | integer | Y | Unique numeric identifier |
| action | Delivery activation status Only ad groups in DRAFT state, that have never gone live or scheduled to go live previously can be ARCHIVED | 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/adGroups/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, "adGroupId": 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/adGroups/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, "adGroupId": 1, "action": "pause" }, { "advertiserId": 1, "adGroupId": 2, "action": "resume" }, { "advertiserId": 1, "adGroupId": 3, "action": "archive" }, { "advertiserId": 1, "adGroupId": 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 |
| adGroupId | ID of ad group with recently changed delivery status | integer |
Sample Response
[ { "code": "success", "details": ["string"], "adGroupId": 1 }
] Sample Response (Batch Operation)
[ { "code": "success", "details": ["string"], "adGroupId": 1 },
{ "code": "success", "details": ["string"], "adGroupId": 2 },
{ "code": "failure", "details": ["string"], "adGroupId": 3 },
{ "code": "success", "details": ["string"], "adGroupId": 4 }
] Updated 5 months ago