Request This endpoint expects an object.
contactId string Required format: "uuid"
Contact to call on each schedule execution
flowId string Required format: "uuid"
Flow (conversation script) to use for the call
frequency enum Required
How often the schedule should repeat
Allowed values: once daily weekly monthly custom_cron
fromPhoneNumber string Required
Caller ID phone number in E.164 format
name string Required
Human-readable name for the schedule
providerId string Required format: "uuid"
VoIP provider to route the call through
scheduleTime string Required
Time of day to execute in HH:MM or HH:MM:SS format
cronExpression string or null Optional
Custom cron expression, required when frequency is custom_cron
dayOfMonth integer or null Optional
Day of month to run on (1-28), used with monthly frequency
daysOfWeek list of integers or null Optional
Days of week to run on (1=Monday through 7=Sunday), used with weekly frequency
endDate date or null Optional
Date after which the schedule will not execute
maxRetries integer Optional
Maximum number of retry attempts per execution (0-10)
maxRuns integer or null Optional
Maximum number of executions before auto-completing
retryDelayMinutes integer Optional
Minutes to wait before retrying a failed call (1-1440)
retryOnFailure boolean Optional
Whether to retry the call if it fails
Response Schedule created
contactId string format: "uuid"
Contact to call on each execution
createdAt datetime
When the schedule was created
flowId string format: "uuid"
Flow (conversation script) used for the call
frequency enum
How often the schedule repeats
Allowed values: once daily weekly monthly custom_cron
fromPhoneNumber string
Caller ID phone number in E.164 format
id string format: "uuid"
Unique identifier for the schedule
maxRetries integer
Maximum retry attempts per execution
name string
Human-readable name for the schedule
providerId string format: "uuid"
VoIP provider used for routing
retryDelayMinutes integer
Minutes between retry attempts
retryOnFailure boolean
Whether failed calls are retried
runCount integer
Number of times the schedule has executed so far
scheduleTime string
Time of day in HH:MM format
status enum
Current status of the schedule
Allowed values: active paused completed canceled
timezone string
IANA timezone used for schedule_time interpretation
cronExpression string or null Optional
Custom cron expression (when frequency is custom_cron)
dayOfMonth integer or null Optional
daysOfWeek list of integers or null Optional
Days of week (1=Monday through 7=Sunday)
endDate date or null Optional
Date after which the schedule will not execute
flowVersion string or null Optional
Pinned flow version at time of schedule creation
lastRunAt datetime or null Optional
Last execution time in UTC
maxRuns integer or null Optional
Maximum number of executions before auto-completing
nextRunAt datetime or null Optional
Next scheduled execution time in UTC
