How to Delete a Slideshow Using REST API

This article explains how to delete a dashboard slideshow using the REST API in Bold BI.

Authorization

To execute this action, please ensure that 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>

Request Type

• DELETE: This request type is used to delete a specific slideshow.

Steps to Delete a Dashboard Slideshow

To delete a dashboard slideshow , follow the steps outlined below:

1. Use the following endpoint in your API client (e.g., Postman):

   • For Self-Hosted Server:
     https://{yourdomain}/bi/api/site/<site_identifier>/v5.0/slideshows/{slideshowId}

   • For Bold BI Cloud Server:
     https://{yourdomain}/bi/api/v5.0/slideshows/{slideshowId}

   Make sure to replace {slideshowId} with the actual ID of the slideshow you wish to delete. You can find the Slideshow ID and details in this knowledge base article.

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 slideshow will be deleted and will no longer appear in the Slideshow Page in the Bold BI UI.
   

   

For more information on managing the dashboard slideshows, please refer to this documentation.

Response

• 204 No Content: The slideshow was successfully deleted.
• 400 Bad Request: Slideshow ID is empty.
• 401 Unauthorized: Access denied.
• 404 Not Found: Item details not found.
• 405 Method Not Allowed: Request type was not DELETE.
• 417 Expectation Failed: Failed to delete slideshow.

Reference

• How to get the details of a dashboard using REST API
• Manage Slideshows
• How to Get a Specific Slideshow Details using REST API