Update Existing Ad Group- Creative association

Note: PUT API requests will overwrite all current values and are not intended to be used as incremental updates like PATCH operations

Update click URLs and 3p trackers for creatives previously added to ad group, by specifying the request parameters.
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: PUT/api/v1/adGroupCreativeAssociations

Request Parameters

ParameterNotesTypeRequired Possible Values
advertiserIdThe ID of the advertiserintegerYUnique numeric identifier
adGroupIdThe ID of the ad groupintegerYUnique numeric identifier
creativeIdThe ID of the creative to be added to the ad group
Note: To be eligible for the rollback badge, creatives must be created after 06/30/2025. Creatives created before 06/30/2025 are not eligible for rollback badging
stringYUnique numeric identifier
urlTrackerList of tracking URLs and tags per ad unit.
_The urlTracker objects are detailed

here

_
string
badgeSettingsList of badge configurations. Each object can have:
  • type (Enum: ROLLBACK)
  • enabled (default: true)

_The badgeSettings objects are detailed

here

_
Array N
showPriceWhen true, the item’s price appears in the creative.
Default is false if the field is omitted.

Note: You may set showPrice: true, only when:
The ROLLBACK badge is enabled for the creative, and
Exactly one item is associated with the creative.
N
  • true
  • false(default)
associatedItemsList of item IDs to be associated with the creative. Max size: 5

The items should be part of the campaign's featured itemset.
ArrayNvalid itemId

urlTracker Objects

ParameterNotesTypeRequired
adUnitAvailable ad unitsstringY
clickUrlDesktopMWebClick URL for Desktop & mWeb associated with specified adUnit. URLs must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)stringY
clickUrlAppClick URL for App associated with the specified adUnit. Direct links must be hosted on Walmart.com. (e.g. search page, browse page, item page, category page and brand page)stringY
dcmClickUrlDesktopMWebDCM click tracker for Desktop & mWebstringN
dcmImprUrlDesktopMWebDCM impression tracker for Desktop & mWebstringN
dcmImprUrlAppDCM impression tracker for AppstringN
iasImprUrlDesktopMWebIAS impression tracker for Desktop & mWebstringN
iasImprUrlAppIAS impression tracker for AppstringN
dvImprUrlDesktopMWebDV impression tracker for Desktop & mWebstringN
dvImprUrlAppDV impression tracker for AppstringN
iasDesktopMWebTagIAS IVT/ Viewability tracking on Desktop & mWebstringN
dvDesktopMWebTagDV IVT/ Viewability tracking on Desktop & mWebstringN

badgeSettings Objects

Each object represent the each badge setting. Optional field, badgeSettings type array, mandatorily specify associatedItems if enabled is set to true.

ParametersNotesTypeRequiredPossible Values
enabledSpecifies whether the badge is enabled or disabledbooleanNdefault: true
typeType of BadgestringYEnum values: ROLLBACK

Rules for badges, showPrice, items, and clickUrl

  • Badge activation
    • Badge can be enabled only for creatives created after 06/30/2025
    • if badgeSettings is omitted or is an empty array → badges disabled for the creative
    • badgeSettings present without an enabled field → enabled defaults to true
  • showPrice
    • showPrice can be set to true only when
      • the Rollback badge is enabled
      • exactly 1 item is associated to the creative
      • if the creative is created after 06/30/2025
  • Item limits
    • Up to 5 items can be associated to a creative
    • Retrieve valid itemId values from itemId in POST /api/v1/items/list
  • clickUrl if badge or price is enabled
    • 1 item linked → clickUrl must point to that item’s product detail page (PDP).
    • 2–5 items linked → clickUrl must point to a shelf page generated from the creative’s featured item set.

Sample Request

curl --location --request PUT 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations' \
--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", "urlTracker" : { "adUnit" : "MARQUEE", /* All valid adUnit values available are supported */ "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit" : "GALLERY", /* All valid adUnit values available are supported */ "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": false, "type": "ROLLBACK" } ], "showPrice": false, "associatedItems": ["12345","65341"] }
]'

Sample Request (Batch Operation)

curl --location --request PUT 'https://developer.api.us.walmart.com/api-proxy/service/display/api/v1/api/v1/adGroupCreativeAssociations' \
--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", "urlTracker" : [ { "adUnit" : "MARQUEE", "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit" : "GALLERY", "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": false, "type": "ROLLBACK" } ], "showPrice": false, "associatedItems": ["12345","65341"] }, { "advertiserId" : 1, "adGroupId" : 2, "creativeId" : "abcd-1234", "urlTracker" : [ { "adUnit" : "MARQUEE", "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" }, { "adUnit" : "GALLERY", "clickUrlDesktopMWeb" : "https://www.test.com/search?q=test+url+desktop+mweb", "clickUrlApp" : "https://www.test.com/search?q=test+url+desktop+app", "dcmClickUrlDesktopMWeb" : "https://test.net", "dcmImprUrlDesktopMWeb" : "https://test.com/abd.jpeg", "dcmImprUrlApp" : "https://test.com/def.jpeg", "iasImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "iasImprUrlApp" : "https://test.com/def.jpeg", "dvImprUrlDesktopMWeb" : "https://test.com/def.jpeg", "dvImprUrlApp": "https://test.com/def.jpeg", "iasDesktopMWebTag": "https://test.com/def.jpeg", "dvDesktopMWebTag": "https://test.com/def.jpeg" } ], "badgeSettings": [ { "enabled": false, "type": "ROLLBACK" } ], "showPrice": false, "associatedItems": ["12345","65341"] }
]' 

Response

ElementDescriptionType
codeThe response code can have following values:
  • success
  • failure

Click here for more information about Status Codes and Errors
string
detailsDetails will populate success or error message depending upon value of codestring
adGroupIdID of the ad group being updatedinteger
creativeIdID of the creativestring

Sample Response

[ { "code": "success", "details": "ADGROUP_CREATIVE_ASSOCIATION_UPDATED_SUCCESSFULLY", "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" }
]