Request
This endpoint expects an object.
contactIdstringRequiredformat: "uuid"
Contact to call on each schedule execution
flowIdstringRequiredformat: "uuid"
Flow (conversation script) to use for the call
frequencyenumRequired
How often the schedule should repeat
fromPhoneNumberstringRequired
Caller ID phone number in E.164 format
namestringRequired
Human-readable name for the schedule
providerIdstringRequiredformat: "uuid"
VoIP provider to route the call through
scheduleTimestringRequired
Time of day to execute in HH:MM or HH:MM:SS format
cronExpressionstring or nullOptional
Custom cron expression, required when frequency is custom_cron
dayOfMonthinteger or nullOptional
Day of month to run on (1-28), used with monthly frequency
daysOfWeeklist of integers or nullOptional
Days of week to run on (1=Monday through 7=Sunday), used with weekly frequency
endDatedate or nullOptional
Date after which the schedule will not execute
maxRetriesintegerOptional
Maximum number of retry attempts per execution (0-10)
maxRunsinteger or nullOptional
Maximum number of executions before auto-completing
retryDelayMinutesintegerOptional
Minutes to wait before retrying a failed call (1-1440)
retryOnFailurebooleanOptional
Whether to retry the call if it fails
Response
Schedule created
contactIdstringformat: "uuid"
Contact to call on each execution
createdAtdatetime
When the schedule was created
flowIdstringformat: "uuid"
Flow (conversation script) used for the call
frequencyenum
How often the schedule repeats
fromPhoneNumberstring
Caller ID phone number in E.164 format
idstringformat: "uuid"
Unique identifier for the schedule
maxRetriesinteger
Maximum retry attempts per execution
namestring
Human-readable name for the schedule
providerIdstringformat: "uuid"
VoIP provider used for routing
retryDelayMinutesinteger
Minutes between retry attempts
retryOnFailureboolean
Whether failed calls are retried
runCountinteger
Number of times the schedule has executed so far
scheduleTimestring
Time of day in HH:MM format
statusenum
Current status of the schedule
timezonestring
IANA timezone used for schedule_time interpretation
cronExpressionstring or nullOptional
Custom cron expression (when frequency is custom_cron)
dayOfMonthinteger or nullOptional
daysOfWeeklist of integers or nullOptional
Days of week (1=Monday through 7=Sunday)
endDatedate or nullOptional
Date after which the schedule will not execute
flowVersionstring or nullOptional
Pinned flow version at time of schedule creation
lastRunAtdatetime or nullOptional
Last execution time in UTC
maxRunsinteger or nullOptional
Maximum number of executions before auto-completing
nextRunAtdatetime or nullOptional
Next scheduled execution time in UTC
