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

ParametersNotesTypeRequiredPossible Values
advertiserIdThe ID of advertiserintegerYUnique numeric identifier
adGroupIdThe ID of ad groupintegerYUnique numeric identifier
creativeIdID of the creative that has been previously added and is to be deletedstringYValid 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

ElementDescriptionRequiredTypePossible Values
codeThe response code can have following values:
  • success
  • failure

Click here for more information about Status Codes and Errors
Ystringsuccess, failure
detailsDetails 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.
YarrayRefer to this link for detailed error messages
adGroupIdID of the ad group being added to the ad groupYlong
creativeIdID of the creativeYstring
messageHigh-level summary of the error, when available. Nstring 
errorsDetailed information about one or more errors, including the affected field (when applicable), error code, and a human-readable description.Narray<object> 

errors array object details

FieldDescriptionOptional field/Nullable?TypePossible values
fieldJSON field associated with the error. Omitted if the error applies to the request as a whole.Nstring 
errorTypeMachine-readable error code that uniquely identifies the error condition. Applications should use this value for error handling logic.Ystring 
descriptionHuman-readable explanation of the error, including why the request failed and, when possible, how to resolve itYstring 

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" }
]

Did this page help you?