Skip to main content
POST
Create a schedule

Body

application/json
name
string
required

Schedule name

Example:

"Daily Report"

type
enum<string>
required

Schedule type

Available options:
interval,
daily,
cron
Example:

"interval"

message
string
required

Message sent to agent on each scheduled execution

Example:

"Run the daily report task"

interval
number

Interval in minutes (required for type "interval")

Required range: 1 <= x <= 43200
Example:

60

time
string

Time in HH:mm format (required for type "daily")

Example:

"09:00"

cron
string

Cron expression (required for type "cron")

Example:

"0 9 * * *"

timezone
string
default:America/Sao_Paulo

Timezone for scheduled executions

Example:

"America/Sao_Paulo"

maxExecutions
number
default:0

Maximum number of executions (0 = unlimited)

Required range: x >= 0
Example:

0

metadata
object

Additional metadata for the schedule

Example:
executionContext
object

Conversation context captured automatically by the SDK (entityType, entityValue, sessionId, userId)

Response

201

Schedule created successfully.