Skip to main content
PATCH
Update a rule

Path Parameters

id
string
required

Rule ID

Example:

"1"

Query Parameters

orgId
string
required

Organization ID. Use GET /v1/companies to discover available org/company pairs.

Example:

"1"

companyId
string
required

Company ID. Use GET /v1/companies to discover available companies and their access levels.

Example:

"1"

Body

application/json
name
string
Required string length: 1 - 127
description
string | null
Maximum string length: 255
conditions
unknown
actions
null[]
conditionsLength
integer
Required range: x >= 0
actionsLength
integer
Required range: x >= 0
isActive
boolean
order
integer

Apply priority. 0 is the highest priority; rules apply in ascending order.

Required range: x >= 0

Response

Rule updated successfully

success
enum<boolean>
required
Available options:
true
data
object
required
Last modified on July 10, 2026