Skip to main content
PATCH
Update ruleset

Authorizations

Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Path Parameters

id
string
required

Ruleset ID

Body

application/json

Update attributes

Only DRAFT rulesets are editable. Omit a field to leave it unchanged.

description
string
rules
RuleInput · object[]

Replaces the full rules array

Response

Updated ruleset

id
string<uuid>
activated_at
string<date-time> | null
context
string
Example:

"checkout"

created_at
string<date-time>
created_by
string | null
description
string | null
rules
Rule · object[]

Rule definitions evaluated in array order

status
enum<string>
Available options:
DRAFT,
ACTIVE,
INACTIVE
version
integer
Example:

1