Activate schedule
  • 02 Nov 2020
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Activate schedule

  • Dark
    Light
  • PDF

Article summary

Schedule

PUT /external/schedule/{externalId}/activate

NameData TypeDescription
Content-type:application/jsonfor all requests
Authorization:EAPI {token}for all requests

Body Parameters

Parameters indicated with a * are mandatory

Name
Data Type
Description
*ExternalIdstring (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

CodeDescription
200Successful operation
403Not allowed to use external API
400Possible 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
500Internal server error

Was this article helpful?