Delete Existing Ad Group - Creative association
Delete creatives from ad group
Note: This API supports batch operations with a max batch size of 5. For bulk operation, the advertiserId must be the same across all requests in the payload
URL: POST/api/v1/adGroupCreativeAssociations/delete
Request Parameters
| Parameters | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of advertiser | integer | Y | Unique numeric identifier |
| adGroupId | The ID of ad group | integer | Y | Unique numeric identifier |
| creativeId | ID of the creative that has been previously added and is to be deleted | string | Y | Valid creative ID |
Note: If the last approved creative in an active ad group is deleted, the ad group will cease to serve ads and will revert to DRAFT status.
Sample Request
curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations/delete ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '[ { "advertiserId" : 1, "adGroupId" : 1, "creativeId" : "abcd-1234" }
]'Sample Request (Batch Operation)
curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations/delete ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <auth_token>' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_CONSUMER.ID: abcde-v123-fa2r-a1fs-asd45f6qef' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--data '[ { "advertiserId" : 1, "adGroupId" : 1, "creativeId" : "abcd-1234" }, { "advertiserId" : 1, "adGroupId" : 1, "creativeId" : "abcd-1234" }
]'Response
| Element | Description | Required | Type | Possible Values |
|---|---|---|---|---|
| code | The response code can have following values:
Click here for more information about Status Codes and Errors | Y | string | success, failure |
| details | Details will populate success or error message depending upon value of code. For code=failure, it is a list of error codes associated with the request. Use these codes for programmatic error handling. | Y | array | Refer to this link for detailed error messages |
| adGroupId | ID of the ad group being added to the ad group | Y | long | |
| creativeId | ID of the creative | Y | string | |
| message | High-level summary of the error, when available. | N | string | |
| errors | Detailed information about one or more errors, including the affected field (when applicable), error code, and a human-readable description. | N | array<object> |
errors array object details
| Field | Description | Optional field/Nullable? | Type | Possible values |
|---|---|---|---|---|
| field | JSON field associated with the error. Omitted if the error applies to the request as a whole. | N | string | |
| errorType | Machine-readable error code that uniquely identifies the error condition. Applications should use this value for error handling logic. | Y | string | |
| description | Human-readable explanation of the error, including why the request failed and, when possible, how to resolve it | Y | string |
Sample Response
[ { "code": "success", "details": "ADGROUP_CREATIVE_DELETION_SUCCESS", "adGroupId": 1, "creativeId": "abcd-1234" }
]Sample Response (Batch Operation)
[ { "code": "success", "details": ["string"], "adGroupId": 1, "creativeId": "abcd-1234" }, { "code": "failure", "details": ["string"], "adGroupId": 1, "creativeId": "abcd-12345" }
]Updated 23 days ago
Did this page help you?
