PATCH

Try PATCH /agents/repos/{owner}/{repo}/automations/{automation_id} — GitHub API

GitHub playground

Edit an automation for a repository

Credentials

GitHub token · sent as Authorization

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Accept · fixedX-GitHub-Api-Version · fixed

Path

owner · required · string The account owner of the repository. The name is not case sensitive. repo · required · string The name of the repository. The name is not case sensitive. automation_id · required · string The unique identifier of the automation.

Body application/json

10 body fields

name · optional · string — The name of the automation.
enabled · optional · boolean — Set to true to enable, false to disable. Omit to leave unchanged.
write_scope · optional · string — Controls which repository resources a run may modify. `trigger` limits writes to the resource that started the run, when one exists, and resources created during the run; `repository` allows writes to any resource in the repository. Supported values: `trigger`, `repository`. Omit to leave unchanged.
require_actor_write_permission · optional · boolean — When true, event-triggered runs require the event actor to have repo write permission, even when the org's allow_read_access_triggers policy is enabled. Does not apply to interval-scheduled runs, which always run as the automation owner. Omit to leave unchanged.
model · optional · string — The model to use for sessions triggered by this automation. Omit to leave unchanged. Send an empty string to clear the model and revert to the platform default.
reasoning_effort · optional · string — The reasoning effort to use for sessions triggered by this automation. Omit to leave unchanged. Send an empty string to clear the override. Currently supported values: `none`, `low`, `medium`, `high`, `xhigh`, `max`
triggers · optional · object — Public trigger configuration keyed by stable public trigger identifier. Each trigger has a closed, trigger-specific configuration schema.
prompt · optional · string — The prompt template for the automation.
tools · optional · string[] — The tools available to the automation. Send an empty array to clear all tools.
allowed_custom_agents · optional · string[] — Custom agents (subagents) this automation is allowed to invoke. Send an empty array to clear all custom agents.