Activate schedule

Prev Next

Schedule

PUT /external/schedule/{externalId}/activate

Header

Name Data Type Description
Content-type: application/json for all requests
Authorization: EAPI {token} for all requests

Body Parameters

Parameters indicated with a * are mandatory

Name
Data Type
Description
*ExternalId string (64) Schedule external id

Sample Request URL

https://api.cirrusplatform.com/api/v1/integrations/external/schedule/EXT_sch_1/activate

Sample Response

{
    "Success": true,
    "Errors": null
}

Response codes

Code Description
200 Successful operation
403 Not allowed to use external API
400 Possible error codes:
Schedule hasn't been found by external id
Schedule is already activated
Can’t activate schedule (schedule has invalid information)
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