Automations

Update an automation

Partial update of the automation's configuration. Send only the fields you want to change. The same name, instructions and tools rules as create apply to the fields you send. Triggers are managed through the triggers sub-resource. Only the automation's creator can change it; workspace owners and admins can pause or delete it. Anyone else receives 403 automation_owner_only. A system automation (include=system) is changed only by workspace owners and admins (403 workspace_agent_admin_only); any member may add a trigger to it, which runs as that member, and remove their own triggers.

<sub>Scope: automations:write</sub>

patch/v3/organizations/{orgId}/automations/{automationId}

Request

  • Base URL: https://api.reasonmachines.com
  • URL: https://api.reasonmachines.com/v3/organizations/{orgId}/automations/{automationId}
  • Auth: HTTP bearer

Request body

namestring

Display name, trimmed, at most 200 characters. Blank returns 400 name_required.

instructionsstring

Trimmed, at most 100,000 characters. Blank returns 400 instructions_required.

modelstring nullable
enabledboolean

Set false to pause the automation. A paused automation's triggers never fire.

Response

Updated.

idstring
org_idstring
namestring nullable
instructionsstring nullable

The system instructions the automation runs with.

modelstring nullable
enabledboolean

A paused (false) automation's triggers never fire.

created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.