Create Schedule

This endpoint is used to create a base schedule.

Response Payload Object

PropertyTypeDescription
descriptionstringThe description of the schedule.
idlongThe Id of the newly created schedule.
isAutomaticbooleanWhether or not to open the doors automatically during the associated cron schedules.
namestringThe name of the schedule.
siteIdlongThe Id of the associated site.
cronSchedulesArray of CronSchedule objectsSee here for more information.

🚧

Any fields returned in the response's payload that are not listed here are "empty" fields that should be ignored as they will always be the same value or will not be filled in.

Controlled Errors

Error CodeError Message
error_schedule_is_nullNull data provided to create the schedule.
error_site_not_foundNo site Id provided.
error_schedule_processingSchedule creation failed.
error_cron_has_no_durationNo valid time duration was provided for a cron schedule.
error_cron_invalid_intervalInvalid end date provided for a cron schedule. If not null, the end date must be after start date.
error_cron_invalid_expressionExpression is either null, empty, or in an invalid format for a cron schedule.

Any status codes returned that are not provided here are generic status codes that can be found here.

Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!