Skip to main content

ScheduleRead

A working-hours schedule for an agent. Message schedules restrict sends to their configured windows unless scheduling is disabled. The human_clarification schedule instead controls when the chatbot may open a new manager clarification; it does not restrict answers to existing clarifications. An agent can have one schedule per type.

idIdrequired

Unique numeric identifier of the record.

agent_idAgent Idrequired

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

created_atdate-timerequired

Creation time (UTC, ISO 8601).

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_typeScheduleTyperequired

Which activity the schedule governs — common, replies, outreach, ping, callback, or human_clarification. Human clarification does not fall back to common; without its own schedule it is available 24/7.

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

ScheduleRead
{
  "id": 0,
  "agent_id": 0,
  "created_at": "2024-07-29T15:51:28.071Z",
  "config": {
    "days": {}
  },
  "schedule_type": "common"
}