Task Automations

Update an existing automation

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

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

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

allowedToolsstring[]

Tool names the AI may use during chat (e.g. promptForSecret, promptForInfo). Null means all tools are allowed.

setupStatus'building' | 'ready' | 'action_needed' | 'failed'

Current state of automated setup performed by the AI queue

setupTaskobject nullable

Specific information or intervention required from the user to continue setup

Example request

{
  "name": "GitHub Security Check - Evidence Collection",
  "description": "Collects evidence about GitHub repository security settings",
  "allowedTools": [
    "promptForSecret",
    "promptForInfo"
  ]
}

Response

Automation updated successfully

successboolean

Example response

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

Changes

Changed in 3 of the 51 revisions of this API.16

Aug 13, 202695679a9aa6253See the full diff
- ○
  added the new optional request property allowedTools
  new-optional-request-property
- ○
  added the new optional request property setupStatus
  new-optional-request-property
- ○
  added the new optional request property setupTask
  new-optional-request-property
Apr 29, 202636253e8a5c1b1See the full diff
- ○
  added the new optional request property scheduleFrequency
  new-optional-request-property
Mar 5, 2026946edaa856a912See the full diff
- ●
  deleted the header request parameter X-Organization-Id
  request-parameter-removed
- ○
  added the new optional request property evaluationCriteria
  new-optional-request-property
- ○
  added the new optional request property isEnabled
  new-optional-request-property
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history