TRtrycompai
Task Automations

Update an existing automation

Changed on

Update an existing automation in Comp AI. Create, version, run, and inspect automated evidence collection workflows attached to compliance tasks.

patch/v1/tasks/{taskId}/automations/{automationId}

Request

  • Base URL
    https://api.trycomp.ai
  • Auth
    API key in header X-API-Key

Path parameters

taskIdstring required
Example:tsk_abc123def456

Unique task identifier

automationIdstring required
Example:auto_abc123def456

Unique automation identifier

Request body

namestring

Automation name

descriptionstring

Automation description

isEnabledboolean

Whether the automation is enabled

evaluationCriteriastring

Evaluation criteria for the automation

scheduleFrequency'daily' | 'weekly' | 'monthly' | 'quarterly' | 'yearly'

Automation schedule cadence

Example request

{
  "name": "GitHub Security Check - Evidence Collection",
  "description": "Collects evidence about GitHub repository security settings"
}

Response

Automation updated successfully

successboolean

Example response

{
  "success": true,
  "automation": {
    "id": "auto_abc123def456",
    "name": "Updated Automation Name",
    "description": "Updated description"
  }
}

Changes