Delete brand
delete/v1/brand/deleteThis API is used to delete the brand. You can delete the existing brand, and the deleted brand cannot be retrieved.
Code snippet
curl -X DELETE 'https://api.boldsign.com/v1/brand/delete?brandId={brandid}' \
-H 'X-API-KEY: {your API key}'
var apiClient = new ApiClient("https://api.boldsign.com", "Your_API_Key");
var brandingClient = new BrandingClient(apiClient);
brandingClient.DeleteBrand("YOUR_BRAND_ID");
import boldsign
configuration = boldsign.Configuration(api_key="YOUR_API_KEY")
with boldsign.ApiClient(configuration) as api_client:
branding_api = boldsign.BrandingApi(api_client)
branding_api.delete_brand(brand_id="YOUR_BRAND_ID")
<?php require_once "vendor/autoload.php";
use BoldSign\Configuration;
use BoldSign\Api\BrandingApi;
$config = new Configuration();
$config->setApiKey('YOUR_API_KEY');
$branding_api = new BrandingApi($config);
$branding_api->deleteBrand($brand_id = 'YOUR_BRAND_ID');
ApiClient client = Configuration.getDefaultApiClient();
client.setApiKey("YOUR_API_KEY");
BrandingApi brandingApi = new BrandingApi(client);
brandingApi.deleteBrand("YOUR_BRAND_ID");
import { BrandingApi } from "boldsign";
const brandingApi = new BrandingApi();
brandingApi.setApiKey("YOUR_API_KEY");
brandingApi.deleteBrand("YOUR_BRAND_ID");
Query parameters
| brandIdstringRequired | The brand Id obtained after successful brand creation needs to be passed to delete the brand. |
Example response
200 Success
{
"message": "The brand has been deleted successfully"
}