delete https://api.sigmacomputing.com/v2/workbooks//schedules/
This endpoint deletes a specific scheduled export from a workbook. Deleting a schedule prevents any previously configured exports or alerts from being triggered at the scheduled times.
Usage notes
- The
workbookId
in the path is required to identify the workbook. Retrieve the workbookId by calling the /v2/workbooks endpoint. - The
scheduleId
in the path is required to specify which schedule to delete. Retrieve the scheduleId by calling the /v2/workbooks/{workbookId}/schedules endpoint and using thescheduledNotificationId
in the response.
Usage scenarios
- Cleanup operations: Use this endpoint to remove unnecessary or outdated schedules that are no longer relevant to the workbook's current use case.
- Configuration updates: When a workbook's usage patterns change, corresponding schedules might need to be deleted to align with the new setup.
Best practices
- Make sure that deleting a given schedule is in compliance with your organization's data governance and operational policies.
- Verify the
scheduleId
andworkbookId
before making a deletion request to prevent errors.