Sign in

v1

latestOpenAPI 3.1.02026-07-26269227514.8 KB
schedules

Update schedule

Update an existing schedule.

patch/v3/organizations/{org_id}/schedules/{schedule_id}

Path parameters

schedule_idstring required
Example:sched-abc123def456

Schedule ID (prefix: sched-)

org_idstring required
Example:org-abc123def456

Organization ID (prefix: org-)

Request body

agent'devin' | 'data_analyst' nullable
bypass_approvalboolean nullable
enabledboolean nullable
frequencystring nullable
interval_countinteger nullable
namestring nullable
notify_on'always' | 'failure' | 'never' nullable
platformstring nullable

VM platform for sessions spawned by this schedule (e.g. 'windows'). When omitted, the platform is left unchanged. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels.

playbook_idstring nullable
promptstring nullable
run_as_user_idstring nullable

Set the user ID that this schedule will run as. Requires ImpersonateOrgSessions permission. Setting to null reverts to the default bot user. Omitting the field leaves the current identity unchanged.

schedule_type'recurring' | 'one_time' nullable
scheduled_atstring date-time nullable
slack_channel_idstring nullable
slack_team_idstring nullable
tagsstring[] nullable
target_devin_idstring nullable

Response

Successful Response

agent'devin' | 'data_analyst' required
bypass_approvalboolean
consecutive_failuresinteger required
created_atstring date-time required
created_bystring nullable required
enabledboolean required
frequencystring nullable required
interval_countinteger
last_edited_bystring nullable
last_error_atstring date-time nullable required
last_error_messagestring nullable required
last_executed_atstring date-time nullable required
namestring required
notify_on'always' | 'failure' | 'never' required
org_idstring required
platformstring nullable
promptstring required
schedule_type'recurring' | 'one_time'
scheduled_atstring date-time nullable
scheduled_session_idstring required
slack_channel_idstring nullable
slack_team_idstring nullable
tagsstring[] nullable
target_devin_idstring nullable
updated_atstring date-time required