Delete Custom Image
Use this method to delete a custom image from the specified Sponsored Brands profile.
URL: DELETE /api/v2/sba_profile/:sba_profile_id/custom_image
Note: Delete Custom Image feature is not live and is available only in sandbox for testing.
Path Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| sbaProfileId | The ID of the Sponsored Brands profile | integer | Y | A valid Sponsored Brands profile ID |
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 DELETE \ "https://developer.api.walmart.com/api-proxy/service/WPA/Api/v1/api/v2 /sba_profile/:sba_profile_id/custom_image" \ --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'\
Response
| Element | Description | Type |
|---|---|---|
| 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. See examples of details specific to custom image upload in Failure Responses. | string |
| sbaProfileId | ID of the Sponsored Brands profile associated with the custom image | integer |
Sample Response
{ "sbaProfileId": 4444444, "code": "success", "details": "" } Failure Responses
{ "sbaProfileId": 0, "code": "failure", "details": "SBA Custom Image feature is not enabled"
}
{ "sbaProfileId": 0, "code": "failure", "details": "Campaign is Under review, modifying is not allowed."
}
{ "sbaProfileId": 0, "code": "failure", "details": "SBA Profile details not found "
}
{ "sbaProfileId": 0, "code": "failure", "details": "You do not have write permission to this advertiser"
}
{ "sbaProfileId": 0, "code": "failure", "details": "You cannot update the enabled one for campaigns which are scheduled or currently live."
}
Updated 5 days ago