Delete a report schedule
DELETE
/v1/report-schedules/{reportScheduleId}Deletes a report schedule at once, so it makes no more snapshots and sends no more emails. It cannot be undone.
The snapshots it has already made are kept. Find them in List reports by their reportScheduleId, and delete them one by one if you no longer want them.
The response is an empty 201. Deleting it again returns 404.
The old documentation called the path parameter {reportId}. It is the schedule's id, reportScheduleId.
Request
curl -X DELETE "https://api.eu.silktide.com/v1/report-schedules/2" \
-H "Authorization: silktide token=$SILKTIDE_API_KEY"Request
Path parameters
reportScheduleIdintegerrequiredat least 1The report schedule.
Response
201No body.
Errors
| Status | Type | When |
|---|---|---|
| 403 | EditionNotAvailable | The account does not have Silktide 4. Reports, report schedules and report templates are Silktide 4's, so an account with only Silktide 5 cannot use them. |
| 400 | InvalidRequest | reportScheduleId is not a whole number. properties.field is reportScheduleId. |
| 404 | ModelNotFound | No report schedule with that id exists in the account. |
| 403 | AccessDenied | The API key's user cannot see or admin the report schedule. |
| 401 | NotLoggedIn | No API key was sent, or it is not a key for this region.(any operation) |
| 429 | TooManyRequests | Too many requests to this path in five seconds. Retry after the number of seconds in the Retry-After header, which properties.retryAfter repeats.(any operation) |
| 503 | - | Silktide is busy. Retry after the number of seconds in the Retry-After header.(any operation) |
Every error has the same body. See Errors.
Access
- Permission
- Can admin this report schedule
- Plan feature
- None
- Edition
- Silktide 4 only
- Cost
- Free
- Available since
- v1.0.0
Try it
Sends a real request to your account from this browser. Your key stays in this tab and goes only to the Silktide API.