Pause a schedule

Pause a schedule’s future fires and keep it for a later resume.

POST /api/v2/schedules/{schedule_id}/pause

Python

from hai_agents import Client, PauseSchedule

client = Client()

schedule = client.schedules.pause_schedule(
    schedule_id,
    request=PauseSchedule(note="Paused during site maintenance"),
)
print(schedule.paused, schedule.pause_note)

Behavior

While paused, next_run_times is empty and the schedule can still be fired manually with Trigger.

Path parameters

schedule_id · string · required

The schedule’s ID (UUID).

Request body

note · string

Why the schedule is paused, up to 255 characters. Returned as pause_note.

Response

200 with the updated schedule object with paused: true.

Python

from hai_agents import Client, PauseSchedule

client = Client()

schedule = client.schedules.pause_schedule(
    schedule_id,
    request=PauseSchedule(note="Paused during site maintenance"),
)
print(schedule.paused, schedule.pause_note)

Errors

Status	Cause
404	Not found, or not in your organization.