Skip to main content
PATCH
Update automation

Path Parameters

automationId
string
required

Body

application/json
name
string
Required string length: 1 - 120
description
string | null

Set to null to clear the description

Maximum string length: 500
isEnabled
boolean

Re-enabling a schedule automation restarts it from the next upcoming tick.

trigger
object

Replaces the whole trigger

action
object

Replaces the whole action

projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
automation
object
required