Update Brand Asset
URL: PUT /api/v1/brand_assets
Notes:
- Updates to
headlineText,clickURL, orbrandswill changereviewStatusto pending - You can't update a brand asset in the following scenarios:
- When a review is pending for the given brand asset
- When the brand asset is associated with a campaign
- When the brand asset is rejected
Query Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the advertiser | integer | Y | Unique advertiser ID |
Request Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| brandAssetID | ID of the brand asset | integer | Y | A valid brand asset ID |
| promotedBrand | Brand that will be shown in the ad as “Sponsored by brand” | string | Y | Valid brand name Note: The character limit is 35 characters |
| associatedBrands | All brands to feature in your Sponsored Brands ad | string | Y | Valid brand name Note: The character limit is 255 characters |
| brandAssetName | Name of the brand asset | string | N | The selected image must meet the following requirements:
|
| headlineText | Custom headline text showcasing why customers should buy your products | string | N | Piece of text that explains your brand value within following constraints:
|
| clickUrl | The website address that a visitor lands on when he/she clicks on the ad. | string | N | Clickable URL must be a https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of the following:
|
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The token will provide you the access to the API. It is same for all advertisers you access through the API. | Y | Please utilize the generated auth_token shared with you at the time of partner onboarding from the Getting Started Guide |
| WM_CONSUMER.ID | We will provide you the consumer ID to access the API. It is same for all advertisers you access through the API. | Y | Please use the generated ConsumerId shared with you at the time of partner onboarding. Refer to the Getting Started Guide for more information |
| WM_SEC.AUTH_SIGNATURE | Auth signature as an API key. | Y | Use the signature generator code from Getting Started Guide to generate this value |
| WM_SEC.KEY_VERSION | We will provide you with the KEY VERSION to access the API. It is same for all advertisers you access through the API. | Y | 1 |
| WM_CONSUMER.intimestamp | Timestamp for which the auth signature is generated. Use Unix epoch format for the timestamp. | Y | Use the signature generator code from Getting Started Guide to generate this value |
Sample Request
curl -X PUT \ 'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/brand_assets?advertiserId=400000' \ --header 'accept: 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 '[ { "brandAssetId": 12345, "brandAssetName": "Brand Name to be updated", "promotedBrand": "main brand", "associatedBrands": ["brand1", "brand2"], "headlineText":"Example Headline Text", "clickUrl":"https://www.walmart.com/2" }, { "brandAssetId": 23456, "brandAssetName": "Brand Name to be updated23", "promotedBrand": "main brand", "associatedBrands": ["brand1", "brand3"], "headlineText":"Example Headline Text2", "clickUrl":"https://www.walmart.com/3" } ]'
Response
| Parameter | Description | Type |
|---|---|---|
| brandAssetId | The ID of the brand asset to be updated | integer |
| code | The response code can have following values: success, failureClick here for more information on API Status Codes and Errors | string |
| details | Details of the error if value of response code is failure. | string |
Sample Response
[ { "brandAssetId": 10101, "code": "success", "details": "" }
]
Updated about 2 months ago