Skeddly API
Search
K
Comment on page

ActionSchedule Object

Description

Represents an action schedule

Properties

parameters

Additional parameters for the schedule. The object value is dependent on the value of scheduleType.
Type: ScheduleParameters object.
Required: Yes

scheduleType

Type of schedule.
Type: string
Valid Values:
  • none
  • hourly
  • daily
  • weekly
  • monthly
Type: string
Required: Yes

startDate

First date of possible execution for the schedule, in yyyy-mm-dd format.
Type: string
Required: Yes

timeOfDay

Time of day to execute, in hh:mm:ss format. Time is local to the specified time zone.
Type: string
Required: Yes

timeZoneId

Time zone in which the schedule resides.
Type: string
Required: Yes

Sample JSON

{
"scheduleType": "daily",
"startDate": "2016-06-10",
"timeOfDay": "12:23:00",
"timeZoneId": "Eastern Standard Time",
"parameters": {
"days": [
"monday",
"tuesday",
"wednesday",
"thursday",
"friday"
]
}
}