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,
"order": 0
}
'import requests
url = "https://api.breezing.io/v1/rules"
payload = {
"name": "<string>",
"actions": [None],
"conditionsLength": 1,
"actionsLength": 1,
"description": "<string>",
"conditions": "<unknown>",
"isActive": True,
"order": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
actions: [null],
conditionsLength: 1,
actionsLength: 1,
description: '<string>',
conditions: '<unknown>',
isActive: true,
order: 0
})
};
fetch('https://api.breezing.io/v1/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.breezing.io/v1/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'actions' => [
null
],
'conditionsLength' => 1,
'actionsLength' => 1,
'description' => '<string>',
'conditions' => '<unknown>',
'isActive' => true,
'order' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.breezing.io/v1/rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.breezing.io/v1/rules")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breezing.io/v1/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 123
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Rules
Create Rule API
Create a Breezing automation rule with conditions and actions to categorize new crypto transactions automatically across accounting workflows.
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,
"order": 0
}
'import requests
url = "https://api.breezing.io/v1/rules"
payload = {
"name": "<string>",
"actions": [None],
"conditionsLength": 1,
"actionsLength": 1,
"description": "<string>",
"conditions": "<unknown>",
"isActive": True,
"order": 0
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
actions: [null],
conditionsLength: 1,
actionsLength: 1,
description: '<string>',
conditions: '<unknown>',
isActive: true,
order: 0
})
};
fetch('https://api.breezing.io/v1/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.breezing.io/v1/rules",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'actions' => [
null
],
'conditionsLength' => 1,
'actionsLength' => 1,
'description' => '<string>',
'conditions' => '<unknown>',
'isActive' => true,
'order' => 0
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.breezing.io/v1/rules"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.breezing.io/v1/rules")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.breezing.io/v1/rules")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"actions\": [\n null\n ],\n \"conditionsLength\": 1,\n \"actionsLength\": 1,\n \"description\": \"<string>\",\n \"conditions\": \"<unknown>\",\n \"isActive\": true,\n \"order\": 0\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": 123
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>"
}
}Query Parameters
Organization ID. Use GET /v1/companies to discover available org/company pairs.
Example:
"1"
Company ID. Use GET /v1/companies to discover available companies and their access levels.
Example:
"1"
Body
application/json
Required string length:
1 - 127Opaque JSON actions array. Required.
Number of distinct conditions in conditions. Used by the UI; pass the count.
Required range:
x >= 0Number of actions in actions. Used by the UI; pass the count.
Required range:
x >= 0Maximum string length:
255Opaque JSON conditions object. Required. Mirror the shape produced by the Breezing rule-builder UI.
Apply priority. 0 is the highest priority; rules apply in ascending order.
Required range:
x >= 0Last modified on July 10, 2026
⌘I