Enable or disable automation rule

PATCH/v1/automation/rules/{ruleID}

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

ruleIDstringrequired

Automation rule ID

Request body

requiredapplication/json

enabledboolean | nullrequired

Enable/disable the rule

Responses

200OK

actionsAutomationRuleAction[] | nullrequired

Show properties

Array of AutomationRuleAction

agent_idstring

fixed_agent_idstring

labelstring

label_idstring

strategystring

typestringrequired

created_atstringrequired

created_bystringrequired

enabledbooleanrequired

idstringrequired

namestringrequired

organization_idstringrequired

scopeAutomationRuleScoperequired

Show properties

channel_typestring

conversation_idstring

triggerAutomationRuleTriggerrequired

Show properties

eventstring

eventsstring[] | null

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PATCH "/v1/automation/rules/string" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'

const response = await fetch("/v1/automation/rules/string", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "enabled": true
})
});

import requests

response = requests.patch(
    "/v1/automation/rules/string",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "enabled": True
},
)

Response

{
  "actions": [
    {
      "agent_id": "string",
      "fixed_agent_id": "string",
      "label": "string",
      "label_id": "string",
      "strategy": "string",
      "type": "string"
    }
  ],
  "created_at": "string",
  "created_by": "string",
  "enabled": true,
  "id": "string",
  "name": "string",
  "organization_id": "string",
  "scope": {
    "channel_type": "string",
    "conversation_id": "string"
  },
  "trigger": {
    "event": "string",
    "events": [
      "string"
    ]
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}