Delete schedule
- 29 Dec 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Delete schedule
- Updated on 29 Dec 2021
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
DELETE /external/schedule/{externalId}
Before using this API method Scheduler id must be set in External API settings of Cirrus app.
Note: Using the API it possible to update a schedule even if a scheduler has opened it in the platform. The last performed save action (by API or GUI) will be the final state. The user will not receive a message if the opened schedule has been updated by the API.
Request Parameters
Parameters indicated with a * are mandatory
| Name | Data Type | Description |
|---|---|---|
| externalId* | String | Schedule external id |
Header
| Name | Data Type | Description |
|---|---|---|
| Content-type: | application/json | for all requests |
| Authorization: | EAPI {token} | for all requests |
Sample Request URL
https://api.cirrusplatform.com/api/v1/integrations/external/schedule/EXT_sch_1
Sample Response
{
"Success": true,
"Errors": null
}
Response codes
| Code | Description |
|---|---|
| 200 | Successful operation |
| 403 | Not allowed to use external API |
| 400 | Possible errors: Schedule hasn't been found by external id Can’t delete schedule Scheduler hasn’t been set in External API settings Selected scheduler no longer has permission to create, update and delete schedules |
| 500 | Internal server error |
Was this article helpful?