Skip to main content

ScheduleCreate

A working-hours schedule for an agent. Messages are only sent within the configured windows (unless an endpoint disables scheduling). An agent can have one schedule per schedule type.

agent_idAgent Idrequired

ID of the agent (a configured AI assistant / bot persona) this record belongs to.

config objectrequired

Per-weekday working-hours configuration.

days objectrequired

Map of weekday ("0"=Monday … "6"=Sunday) to that day's working-hours config.

property name* ScheduleDayConfig

Working-hours configuration for a single weekday.

is_working_dayIs Working Dayrequired

Whether messages may be sent on this day.

time_startTime Start

Start of the working window, "HH:MM" (24h).

Default value: 00:00
time_endTime End

End of the working window, "HH:MM" (24h).

Default value: 00:00
schedule_typeScheduleType

Which activity the schedule governs — common, replies, outreach, ping, or callback.

Possible values: [common, replies, outreach, ping, callback]

Default value: common
ScheduleCreate
{
  "agent_id": 0,
  "config": {
    "days": {}
  },
  "schedule_type": "common"
}