API reference

Update an automation

PATCH/v1/automations/{automationId}

Authorization

Send a personal API key or an OAuth access token as Authorization: Bearer <token>.

OAuth scopes: automations:write

Parameters

automationIdstring (uuid), pathrequired

Request body

application/json, required

namestring
promptstring
effort"low" | "medium" | "high" | "xhigh" | "max" | null
cronstring
timezonestring
runAtstring (date-time) | null
visibility"private" | "team"

Responses

200Success

automationobjectrequired
idstring (uuid)required
namestringrequired
promptstringrequired
effort"low" | "medium" | "high" | "xhigh" | "max" | nullrequired
enabledbooleanrequired
trigger"schedule" | "webhook"required
type"recurring" | "one_time"required
cronstring | nullrequired
timezonestringrequired
runAtstring (date-time) | nullrequired
nextRunAtstring (date-time) | nullrequired
triggerProvider"composio" | nullrequired
triggerEventstring | nullrequired
triggerAppstring | nullrequired
triggerConfigobject | nullrequired
taskIdstring (uuid) | nullrequired
visibility"private" | "team"required
lastRunAtstring (date-time) | nullrequired
lastStatus"running" | "completed" | "failed" | "skipped" | nullrequired
runCountintegerrequired
createdAtstring (date-time)required
updatedAtstring (date-time)required

400Invalid request

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

401Missing or invalid Bearer credential

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

402Payment or subscription required

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

403Credential is missing a required scope

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

404Resource not found

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

409Request conflict

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

429Rate limit exceeded

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

500Internal API error

errorobjectrequired
typestringrequired
messagestringrequired
requestIdstring

curl --request PATCH \
  --url 'https://api.staging.adam.new/v1/automations/{automationId}' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "prompt": "<string>",
  "effort": "low",
  "cron": "<string>",
  "timezone": "<string>",
  "runAt": "2026-01-01T00:00:00.000Z",
  "visibility": "private"
}'

{
  "automation": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "prompt": "<string>",
    "effort": "low",
    "enabled": true,
    "trigger": "schedule",
    "type": "recurring",
    "cron": "<string>",
    "timezone": "<string>",
    "runAt": "2026-01-01T00:00:00.000Z",
    "nextRunAt": "2026-01-01T00:00:00.000Z",
    "triggerProvider": "composio",
    "triggerEvent": "<string>",
    "triggerApp": "<string>",
    "triggerConfig": {},
    "taskId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "visibility": "private",
    "lastRunAt": "2026-01-01T00:00:00.000Z",
    "lastStatus": "running",
    "runCount": 0,
    "createdAt": "2026-01-01T00:00:00.000Z",
    "updatedAt": "2026-01-01T00:00:00.000Z"
  }
}