curl --request POST \
--url https://api.redbark.com/v2/rulesets/{id}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Redbark-Version: <api-key>' \
--data '
{
"name": "<string>",
"conditions": {
"groups": [
{
"conditions": [
{
"value": "<string>"
}
]
}
]
},
"action": {
"type": "skip"
}
}
'const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Redbark-Version': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
conditions: {groups: [{conditions: [{value: '<string>'}]}]},
action: {type: 'skip'}
})
};
fetch('https://api.redbark.com/v2/rulesets/{id}/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.redbark.com/v2/rulesets/{id}/rules"
payload = {
"name": "<string>",
"conditions": { "groups": [{ "conditions": [{ "value": "<string>" }] }] },
"action": { "type": "skip" }
}
headers = {
"Authorization": "Bearer <token>",
"Redbark-Version": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "rule_2Ab4Cd6eFg8hJk0lMn2oPq",
"object": "rule",
"ruleset": "<string>",
"name": "<string>",
"position": 123,
"enabled": true,
"conditions": {},
"action": {},
"metadata": {},
"livemode": true,
"created": "2026-08-21T09:30:00.000Z",
"updated": "2026-08-21T09:30:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Create a rule
Up to 50 rules per ruleset; new rules go last.
curl --request POST \
--url https://api.redbark.com/v2/rulesets/{id}/rules \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Redbark-Version: <api-key>' \
--data '
{
"name": "<string>",
"conditions": {
"groups": [
{
"conditions": [
{
"value": "<string>"
}
]
}
]
},
"action": {
"type": "skip"
}
}
'const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Redbark-Version': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
conditions: {groups: [{conditions: [{value: '<string>'}]}]},
action: {type: 'skip'}
})
};
fetch('https://api.redbark.com/v2/rulesets/{id}/rules', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.redbark.com/v2/rulesets/{id}/rules"
payload = {
"name": "<string>",
"conditions": { "groups": [{ "conditions": [{ "value": "<string>" }] }] },
"action": { "type": "skip" }
}
headers = {
"Authorization": "Bearer <token>",
"Redbark-Version": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "rule_2Ab4Cd6eFg8hJk0lMn2oPq",
"object": "rule",
"ruleset": "<string>",
"name": "<string>",
"position": 123,
"enabled": true,
"conditions": {},
"action": {},
"metadata": {},
"livemode": true,
"created": "2026-08-21T09:30:00.000Z",
"updated": "2026-08-21T09:30:00.000Z"
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}{
"error": {
"type": "invalid_request_error",
"code": "<string>",
"message": "<string>",
"param": "<string>",
"doc_url": "<string>",
"request_id": "<string>"
}
}Authorizations
Authorization: Bearer rbk_live_...
The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.
Path Parameters
The id of the object.
"rset_6Kp8Lm1nQr3sTu5vWx7yZa"
Body
1 - 80Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
Show child attributes
Show child attributes
Up to 50 string pairs. Set a key to null to unset it.
Show child attributes
Show child attributes
Response
Created
"rule_2Ab4Cd6eFg8hJk0lMn2oPq"
rule Groups of conditions (OR across groups, AND within). See the rules guide.
Show child attributes
Show child attributes
{ type: "skip" | "email" | "set_category" | "set_category_group" | "clear_category" | "set_merchant" | "set_description" | "set_note" | "add_tag", value? }
Show child attributes
Show child attributes
Up to 50 string pairs. Set a key to null in an update to unset it.
Show child attributes
Show child attributes
"2026-08-21T09:30:00.000Z"
"2026-08-21T09:30:00.000Z"

