Skip to main content
PATCH
/
v1
/
tasks
/
{taskId}
/
automations
/
{automationId}
Update an existing automation
curl --request PATCH \
  --url https://api.trycomp.ai/v1/tasks/{taskId}/automations/{automationId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "GitHub Security Check - Evidence Collection",
  "description": "Collects evidence about GitHub repository security settings"
}'
{
  "success": true,
  "automation": {
    "id": "auto_abc123def456",
    "name": "Updated Automation Name",
    "description": "Updated description"
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

taskId
string
required

Unique task identifier

Example:

"tsk_abc123def456"

automationId
string
required

Unique automation identifier

Example:

"auto_abc123def456"

Body

application/json
name
string

Automation name

Example:

"GitHub Security Check - Evidence Collection"

description
string

Automation description

Example:

"Collects evidence about GitHub repository security settings"

Response

Automation updated successfully

success
boolean
Example:

true

automation
object
I