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

Documentation Index

Fetch the complete documentation index at: https://learn.breezing.io/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

org_id
string
required

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

Example:

"1"

company_id
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

Response

Rule created successfully

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