Skip to main content
POST
/
api
/
v1
/
rules
/
batch
Batch create rules
curl --request POST \
  --url https://breadbox.example.com/api/v1/rules/batch \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "rules": [
    {
      "name": "<string>",
      "condition": {},
      "actions": [
        {}
      ],
      "enabled": true,
      "priority": 123,
      "triggers": []
    }
  ]
}
'
{
  "rules": [
    {
      "id": "<string>",
      "short_id": "<string>",
      "name": "<string>",
      "enabled": true,
      "priority": 123,
      "creator_id": "<string>",
      "condition": {},
      "actions": [
        {}
      ],
      "triggers": [],
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt

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

Authorizations

​
X-API-Key
string
header
required

Breadbox API key with format bb_<base62>. Carries either read_only or full_access scope. Write endpoints (and a handful of sensitive reads — /api-keys, /users/{user_id}/login) require full_access; endpoints that require it are flagged in their description.

Body

application/json
​
rules
object[]
required

Response

201 - application/json

Created rules.

​
rules
object[]