Response Payload Object

Property	Type	Description
description	string	The description of the schedule.
id	long	The Id of the newly created schedule.
isAutomatic	boolean	Whether or not to open the doors automatically during the associated cron schedules.
name	string	The name of the schedule.
siteId	long	The Id of the associated site.
cronSchedules	Array of CronSchedule objects	See 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 Code	Error Message
error_schedule_is_null	Null data provided to create the schedule.
error_site_not_found	No site Id provided.
error_schedule_processing	Schedule creation failed.
error_cron_has_no_duration	No valid time duration was provided for a cron schedule.
error_cron_invalid_interval	Invalid end date provided for a cron schedule. If not null, the end date must be after start date.
error_cron_invalid_expression	Expression 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.