Skip to main content
PUT
Update automation rule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

id identifier

ruleId
string
required

ruleId identifier

Body

application/json

Partial owner/admin update. Rejects unknown keys and validates the full merged definition and references. An enabled:false-only request can disable an invalid row. Change conditions cannot use issue.created or pr.merged.

schema_version
integer
default:1
name
string
Required string length: 1 - 255
trigger_event
enum<string>
Available options:
issue.created,
issue.status_changed,
issue.assigned,
issue.priority_changed,
pr.merged,
ci.run.completed,
schedule.issue_time
schedule_config
object | null

Required as an object when the merged trigger_event is schedule.issue_time; omit or set to null for an event trigger.

conditions
object[]

All conditions are ANDed. Missing kind is legacy field syntax. changed omits value; changed_from/changed_to use typed values. Change conditions require an issue change trigger.

actions
object[]

Ordered actions; at most one create_issue is permitted.

Executable automation action. Values are validated by action type; invalid actions return 400.

enabled
boolean
project_id
string<uuid> | null

Response

Successful response

The response is of type object.