Sign in
Schedules

Update Schedule

Update fields on an existing schedule. Only supplied fields are changed; omitted fields retain their current values. Owners may update their own schedules; team superadmins may update any schedule on agents in the current team.

patch/v2/agents/{agent_id}/schedules/{schedule_id}

Path parameters

agent_idstring uuid required

The agent's unique identifier

schedule_idstring uuid required

The schedule's unique identifier

Request body

enabledboolean
frequency'every_5_minutes' | 'every_15_minutes' | 'hourly' | 'daily' | 'workday' | 'weekly' | 'monthly' | 'custom'
timestring nullable
timezonestring
day'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday' | 'sunday' nullable
day_of_monthinteger nullable
cronstring nullable
recurringboolean nullable

Response

Default Response

idstring required
build_idstring required
agent_idstring required
user_idstring required
enabledboolean required
frequency'every_5_minutes' | 'every_15_minutes' | 'hourly' | 'daily' | 'workday' | 'weekly' | 'monthly' | 'custom' required
timestring nullable required
timezonestring required
daystring nullable required
day_of_monthnumber nullable required
cronstring nullable required
sourcestring nullable required
taskstring nullable required
recurringboolean nullable required
auto_disabled_atstring nullable required
auto_disabled_reasonstring nullable required
consecutive_missing_connection_failuresinteger required
first_missing_connection_failure_atstring nullable required
last_missing_connection_failure_atstring nullable required
created_atstring required
updated_atstring required
user_namestring nullable
user_emailstring nullable

Changes

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