v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Case Management

Disable an automation rule

Disables an automation rule so it no longer triggers on case events. The rule configuration is preserved.

post/api/v2/cases/projects/{project_id}/rules/{rule_id}/disable

Path parameters

project_idstring required

The UUID of the project that owns the automation rules.

rule_idstring required

The UUID of the automation rule.

Response

OK

Example response

{
  "data": {
    "attributes": {
      "action": {
        "data": {
          "handle": "workflow-handle-123"
        },
        "type": "execute_workflow"
      },
      "created_at": "2024-01-01T00:00:00.000Z",
      "name": "Auto-assign workflow",
      "state": "ENABLED",
      "trigger": {
        "type": "case_created"
      }
    },
    "id": "e6773723-fe58-49ff-9975-dff00f14e28d",
    "relationships": {
      "created_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      },
      "modified_by": {
        "data": {
          "id": "00000000-0000-0000-0000-000000000000",
          "type": "user"
        }
      }
    },
    "type": "rule"
  }
}