How to Delete a Dashboard Schedule using REST API

This article explains how to delete a dashboard schedule 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>

Steps to Delete a Dashboard Schedule

To delete a dashboard schedule, 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/schedules/{scheduleId}

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

   Make sure to replace {scheduleId} with the actual ID of the dashboard schedule you wish to delete. You can find the Schedule 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 schedule will be deleted and will no longer appear in the Schedules Page in the Bold BI UI.
   

   

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

Response

• 204 No Content: The schedule was successfully deleted.
• 400 Item ID Invalid: The provided schedule ID is not valid.
• 401 Access Denied: Authorization failed; check your token.
• 404 Item Details Not Found: The specified schedule could not be found.
• 405 Request Type Was Not DELETE: Ensure you are using the DELETE method.
• 417 Failed to Delete Item: An error occurred while attempting to delete the item.

Reference

• Create a Schedule to Export the Dashboard View using REST API.
• How to get the dashboard schedules using REST API.