Update automation

PATCH
/api/v1/automations/{automationId}

Authorization

bearerAuth
headerAuthorizationBearer <token>

An API key created in Capy under Settings → API.

Path parameters

automationId*string

Request body

application/json
  1. body
name?string
Length1 <= length
description?string
prompt?string
Length1 <= length
triggers?array<||||||>
Items1 <= items <= 20
model?|null
repos?array<>
threadMode?string
One of"new""single"
slackImpersonation?boolean
quietSlackPosts?boolean
singleJamId?string
maxRunsPerDay?|null
machineSize?|null
organize?|null
runAs?|

Response body

AutomationCreated

application/json
  1. response
id*string
projectId*string
name*string
description*string|null
prompt*string
triggers*array<||||||>
model*|

The pinned model, or null when the automation is unpinned and each run resolves the run-as principal's default model at run creation.

repos*array<>
threadMode*string
One of"new""single"
slackImpersonation*boolean
quietSlackPosts*boolean
singleJamId*string|null
mcpOverrides*|null
maxRunsPerDay*integer|null
machineSize*|null
organize*|

How each run's thread lands on the board, applied as the run-as principal when the run creates its thread: pinned, filed into folders, tagged. Null organizes nothing.

enabled*boolean
deleted*boolean
disabledReason*|null
runAsKind*string
One of"human""service"
runAsId*string
runCount*integer
lastTriggeredAt*string|null
nextRunAt?string
createdAt*string
updatedAt*string
webhookUrl*|

The incoming-webhook URL, present only when this save minted the credential: a create with an incoming_webhook trigger, or an update that adds one. It is shown once and never appears in later automation reads.

curl -X PATCH 'https://api.capy.ai/api/v1/automations/string' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "string",  "projectId": "string",  "name": "string",  "description": "string",  "prompt": "string",  "triggers": [    {      "type": "schedule",      "cron": "string",      "timezone": "string"    }  ],  "model": {    "modelId": "string",    "reasoningMode": "none",    "modes": {      "fast": true,      "pro": true,      "ultrafast": true,      "daybreak": true    }  },  "repos": [    {      "repo": "string",      "branch": "string"    }  ],  "threadMode": "new",  "slackImpersonation": true,  "quietSlackPosts": true,  "singleJamId": "string",  "mcpOverrides": {    "enabled_server_keys": [      "string"    ],    "disabled_server_keys": [      "string"    ]  },  "maxRunsPerDay": 0,  "machineSize": "small",  "organize": {    "pin": true,    "folders": [      "string"    ],    "tags": [      "string"    ]  },  "enabled": true,  "deleted": true,  "disabledReason": "run_as_unavailable",  "runAsKind": "human",  "runAsId": "string",  "runCount": 0,  "lastTriggeredAt": "string",  "nextRunAt": "string",  "createdAt": "string",  "updatedAt": "string",  "webhookUrl": "string"}
Open in Capy