How to Delete a Custom Widget Using Bold BI REST API

This article explains how to delete the custom widget using API calls in Bold BI On-Premises using Postman.

Authorization

To execute this action, please ensure that a access token is included in your request header. For details on obtaining the access token, please refer to the relevant documentation here.

Authorization: bearer <token>

Deleting a Custom Widget Using Bold BI REST API

To delete a custom widget using the Bold BI REST API, follow the steps outlined below:

Steps to Delete a Custom Widget

1. Use the below endpoint in postman with DELETE method

   http(s)://{your host}:{your port number}/bi/api/site/{your_site_identifier}/v4.0/custom-widget?widgetIds={widgetId}
   

   Make sure to replace {widgetId} with the actual ID of the widget you wish to delete.

2. Then add the token generated from the ‘token’ endpoint above in the Headers with key as ‘Authorization’ and value as ‘bearer {Your_token}’
   

   

3. Click the “Send” button in your API client. If the request is successful, the custom widget will be deleted and will no longer appear in the Settings > Widget section.
   

   

Response Codes

• 204 - No Content: Custom widget deleted successfully.
• 400 Bad Request: Invalid body syntax - Connector name or Connection JSON is invalid or empty.
• 401 Unauthorized: Authorization token is invalid or has expired.

Reference

• How to Publish a Custom Widget Using Bold BI REST API
• How do I create a dashboard view using Bold BI REST API
• How to add TreeGrid custom widget in dashboard