Schedules

Pause Schedule

Pause a schedule to stop it from executing.

post/agents/{agent_id}/schedules/{schedule_name}/pause

Path parameters

schedule_namestring required

agent_idstring required

notestring nullable

Optional note explaining why the schedule was paused

Successful Response

agent_idstring required

ID of the agent this schedule belongs to

created_atstring date-time nullable

When the schedule was created

last_action_timestring date-time nullable

When the schedule last executed

namestring required

Human-readable name for the schedule

next_action_timesstring[]

Upcoming scheduled execution times

num_actions_missedinteger

Number of scheduled executions that were missed

num_actions_takeninteger

Number of times the schedule has executed

schedule_idstring required

Unique identifier for the schedule

state'ACTIVE' | 'PAUSED' required

Schedule state enum

No recorded changes to this endpoint across all 1 revision of this API.