DeleteAssets API
The DeleteAssets API allows developers to delete assets (domains) from the platform. You can delete multiple assets in a single request using this API.
There are two sections on the Assets page of the Platform from where assets can be deleted:
- Managed by Brand
- Managed by Affiliates
These sections are visible on the platform, but to delete assets via the API, you don’t need to specify the “isAffiliated” flag; simply specifying the domain will delete it from your platform.
Step 1: Locate Your API Key
Before using the DeleteAssets API, you need your Bolster API Key. Follow these steps to find it:
- Click on the user dropdown in the top-right corner of the page.
- Select Profile Information from the dropdown menu.
- Copy the API key displayed on your profile screen.
Step 2: Initiate request through API
To make a DeleteAssets request, use the following details.
Endpoint:
/api/neo/v1/deleteAssets
API Host:
https://developers.bolster.ai
Request Format:
curl --location --request DELETE 'https://developers.bolster.ai/api/neo/v1/deleteAssets' \
--header 'Content-Type: application/json' \
--data '{
"apiKey": "<your_api_key>",
"domainList": [
"example1.com",
"example2.com"
]
}'Request Parameters
- apiKey (required): Your user API key.
- domainList (required): List of assets (domains) you want to delete, formatted as an array of strings.
Response
Upon a successful request, you will receive a response like the following with Status code: 200.
If all domains are deleted successfully:
{
"result": {
"success": 2,
"failure": 0
}
}If the domains are not present or already deleted from the system:
{
"result": {
"success": 0,
"failure": 2
}
}If some domains are deleted and others are not:
{
"result": {
"success": 1,
"failure": 1
}
}If you are unauthorized to access the API or for some other unauthorized reason:
{
"error": {
"statusCode": 401,
"message": "Not authorized."
}
}In case of an unsuccessful request, the following status codes and error messages may be returned:
- Status Code: 500. Message: Invalid API key or API key not enabled.
- Status Code: 400. Message: domainList is a required argument.
- Status Code: 401. Message: Not authorized.
Support
If you have any questions or encounter any issues while using the DeleteAssets API, please contact our support team at support@bolster.ai.
