Skip to main content
PATCH
/
rules
/
{id}
Update a rule
curl --request PATCH \
  --url https://api.breezing.io/v1/rules/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "conditions": null,
  "actions": [
    null
  ],
  "conditionsLength": 1,
  "actionsLength": 1,
  "isActive": true
}
'
{
  "success": true,
  "data": {
    "updated": 123
  }
}

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

Response

Rule updated successfully

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
Last modified on May 3, 2026