Skip to main content

automationDeleteRules

Permanently deletes an automation rule and its execution history.

Runs synchronously: the rule is validated and removed before the mutation returns. Automations are not archived; to keep a rule without running it, set its status to INACTIVE instead.

Business Rules​

  • The rule must exist within the current company.
  • The rule must not be ACTIVE; set it to INACTIVE or DRAFT first.
  • The rule must not have executions in progress.

Error Scenarios​

  • **NOT_FOUND**: when the rule does not exist in the current company.
  • **BAD_REQUEST**: when the rule is active or has executions in progress.

Permissions Required​

  • automation:delete_rule permission
automationDeleteRules(
  input: DeleteAutomationInput!
): StatusResponse

Arguments​

automationDeleteRules.input ● DeleteAutomationInput! non-null input common​

Parameters for DeleteAutomation

Type​

StatusResponse object common​

The response of a mutation that only returns a status