Skip to main content
POST
Create a rule

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
Required string length: 1 - 127
actions
null[]
required

Opaque JSON actions array. Required.

conditionsLength
integer
required

Number of distinct conditions in conditions. Used by the UI; pass the count.

Required range: x >= 0
actionsLength
integer
required

Number of actions in actions. Used by the UI; pass the count.

Required range: x >= 0
description
string | null
Maximum string length: 255
conditions
any | null

Opaque JSON conditions object. Required. Mirror the shape produced by the Breezing rule-builder UI.

isActive
boolean
default:true
order
integer
default:0

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

Required range: x >= 0

Response

Rule created successfully

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