Skip to main content
PATCH
/
api
/
public
/
v1
/
automation
/
{id}
Update automation rule
curl --request PATCH \
  --url https://app.msportal.ai/api/public/v1/automation/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "isActive": true,
  "priority": 50,
  "scopeType": "tenant",
  "companyIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "triggerType": "date_threshold",
  "triggerConfig": {},
  "entityType": "device",
  "conditions": [
    "<unknown>"
  ],
  "actions": [
    "<unknown>"
  ],
  "aggregationConfig": "<unknown>"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "isActive": true,
    "priority": 123,
    "scopeType": "tenant",
    "companyIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "triggerType": "<string>",
    "entityType": "<string>",
    "triggerConfig": {},
    "conditions": [
      {
        "id": "<string>",
        "logic": "AND",
        "conditions": [
          {
            "id": "<string>",
            "field": "<string>",
            "operator": "<string>",
            "value": "<unknown>"
          }
        ],
        "groups": [
          "<unknown>"
        ]
      }
    ],
    "actions": [
      {
        "id": "<string>",
        "actionType": "<string>",
        "config": {},
        "order": 123,
        "requiresApproval": true
      }
    ],
    "aggregationConfig": {
      "enabled": true,
      "groupBy": "<string>",
      "groupField": "<string>",
      "minBatchSize": 123,
      "maxWaitHours": 123,
      "combinedActionConfig": {
        "titleTemplate": "<string>",
        "descriptionTemplate": "<string>"
      }
    },
    "createdBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "updatedBy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "version": 123,
    "companies": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key as a Bearer token. API keys can be generated in Settings → Integrations → API Access.

Path Parameters

​
id
string<uuid>
required

Rule ID

Body

application/json
​
name
string

Rule name

Required string length: 1 - 200
​
description
string | null

Rule description

Maximum string length: 1000
​
isActive
boolean

Whether the rule is active

​
priority
integer

Rule priority

Required range: 0 <= x <= 100
​
scopeType
enum<string>

Rule scope

Available options:
tenant,
company
​
companyIds
string<uuid>[] | null

Company IDs

​
triggerType
enum<string>

Trigger type

Available options:
date_threshold,
scheduled,
field_change,
absence
​
triggerConfig
object

Trigger-specific configuration

​
entityType
enum<string>

Entity type

Available options:
device,
company,
compliance,
planner,
user,
goal,
training,
ticket,
meeting
​
conditions
null[]

Condition groups

​
actions
null[]

Actions to execute

​
aggregationConfig
any | null

Aggregation configuration

Response

Rule updated successfully

​
data
object
required