🌐
v2 URL: PUT/api/v2/sba_profile

Note:

None of the profiles can be updated if a campaign review is pending or in-progress
An approved profile will be switched to pending review when it is updated
You can update Sponsored Brands profile for a live Sponsored Brands campaign as well.
- To update the enabled Sponsored Brands profile in a live campaign, you will have to pause the campaign, update the profile, and submit it for review. To avoid pausing the campaign, we recommend that you create a 2nd profile with the desired changes using v2 URL, submit a review request for its approval, and enable it once it is approved.

Query Parameters

Parameter	Notes	Type	Required	Possible Values
campaignId	The ID of the campaign	integer	Y	A valid campaign ID
adGroupId	The ID of the ad group	string	Y	A valid ad group ID
searchAmpName	The name of the Brand. This field is required.	string	Y	Name of the brand that is part of this profile. It should be max. 35 characters all of which are NOT recommended to be special characters
headlineText	Custom headline text showcasing why customers should buy your products This field is required.	string	Y	Piece of text that explains your brand value within following constraints: It should be max. 45 characters It is recommended to NOT use all special characters in this field
clickUrl	The destination URL or landing page URL. It is the website address that a visitor lands on when he/she clicks on the ad. This field is required.	string	Y	Clickable URL must be https://www.walmart.com URL that displays product(s) for the advertised brand. It can be either of: Search Page Browse Page Brand Shop Brand Shelf clickUrl requirements: Any “:” in the URL should be replaced with “%3A” Any “+” in the URL should be replaced with “%20″ Any “\|\|” in the URL should be replaced with “%7C%7C” URL query string should not contain “typeahead=” parameter For 3P sellers, add hidden_facet=retailer_id%3A<seller_id>to the end of clickURL Note: If requirements not met, the request will fail with encode issue.
sbaProfileId	ID of the Sponsored Brands profile	integer	Y	A valid Sponsored Brands profile ID.
status	Indicator of the enabled state of Sponsored Brands profile	string	N	`enabled`, `disabled`

Sample Request

curl -X PUT \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v2/sba_profile' \
--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'\
--header 'Content-Type: application/json' \
--header 'accept: application/json' \
--data '{ "campaignId": 12345, "adGroupId": 54321, "searchAmpName": "Great Value", "headlineText": "This is Great Value", "clickUrl": "https://www.walmart.com", "sbaProfileId": 600001, "status": "enabled" }'

Response

Element	Description	Type
code	The response code can have following values: `success`, `failure`	string
details	Details of the error if value of response code is `failure`	string
sbaProfileId	ID of the Sponsored Brands profile	integer

Sample Response

[ { "code": "success", "details": "", "sbaProfileId": 600001 }, { "code": "failure", "details": "error message", "sbaProfileId": 0 }
]