Skip to main content
POST
Create a rule

Authorizations

Authorization
string
header
required

Authorization: Bearer rbk_live_...

Redbark-Version
string
header
required

The API release your integration is built against, e.g. 2026-10-01.wattle. Required on every request.

Path Parameters

id
string
required

The id of the object.

Example:

"rset_6Kp8Lm1nQr3sTu5vWx7yZa"

Body

application/json
name
string
required
Required string length: 1 - 80
conditions
object
required
action
object
required
enabled
boolean
metadata
object

Up to 50 string pairs. Set a key to null to unset it.

Response

Created

id
string
required
Example:

"rule_2Ab4Cd6eFg8hJk0lMn2oPq"

object
enum<string>
required
Available options:
rule
ruleset
string
required
name
string
required
position
integer
required
enabled
boolean
required
conditions
object
required

Groups of conditions (OR across groups, AND within). See the rules guide.

action
object
required

{ type: "skip" | "email" | "set_category" | "set_merchant", value? }

metadata
object | null
required

Up to 50 string pairs. Set a key to null in an update to unset it.

livemode
boolean
required
created
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"

updated
string<date-time>
required
Example:

"2026-08-21T09:30:00.000Z"