ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions117

Automation Rule → Update Automation Rule In Account

AI-generated

Summary

Update an existing automation rule in a specified Chatwoot account by modifying its attributes such as name, description, event trigger, active status, conditions, and actions.

Inputs

  • Account Id (required) — The numeric ID of the Chatwoot account where the automation rule exists.
  • Id (required) — The ID of the automation rule to be updated.
  • Name — The updated name for the automation rule.
  • Description — The updated description explaining the automation rule and its actions.
  • Event Name — The event that triggers the automation rule, e.g. conversation_created, conversation_updated, or message_created.
  • Active — Boolean to enable or disable the automation rule.
  • Actions — JSON array defining the actions to perform when conditions match, e.g. adding a label.
  • Conditions — JSON array defining the conditions that trigger the automation rule, e.g. message content contains a specific keyword.

Output shape

a single updated automation rule record as returned by the Chatwoot API

Returns the updated automation rule object. The operation requires the Account Id and Rule Id to locate the rule. Optional fields sent will update the corresponding properties of the rule. The actions and conditions fields expect JSON formatted arrays.

Examples

Example 1: Update an automation rule to disable it and change its name

Provide Account Id and Id of the rule; set Active to false and specify new Name.

Discussion