Skip to main content
PATCH
Update a rule assignment

Authorizations

X-API-KEY
string
header
required

Path Parameters

id
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991

Body

application/json
reason
string
required

Why this assignment is being changed — stored in the rule audit log.

Required string length: 3 - 500
rule_start_date
string

First day the rule applies (inclusive).

Pattern: ^\d{4}-\d{2}-\d{2}$
rule_end_date
string | null

Last day the rule applies (inclusive), or null for open-ended. Omit the field to leave the current end date unchanged.

Pattern: ^\d{4}-\d{2}-\d{2}$
rule_id
string<uuid>
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful response

success
boolean
required