Skip to main content
POST
Move a member to another rule

Authorizations

X-API-KEY
string
header
required

Path Parameters

member_id
string<uuid>
required
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)$

Body

application/json
current_assignment_id
integer
required

The assignment being replaced, from GET /members/{member_id}/rule-assignments.

Required range: -9007199254740991 <= x <= 9007199254740991
rule_id
string<uuid>
required

The rule to move the member to.

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)$
allowance_type_id
string<uuid>
required
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)$
valid_from
string
required

First day the new rule applies (inclusive), in YYYY-MM-DD format. Must be after the current assignment's start date.

Pattern: ^\d{4}-\d{2}-\d{2}$
reason
string
required

Why the member is being moved — stored in the rule audit log.

Required string length: 3 - 500
valid_until
string | null

Last day the new rule applies (inclusive), in YYYY-MM-DD format, or null for open-ended. To cover the member through 2026-08-31, send 2026-08-31.

Pattern: ^\d{4}-\d{2}-\d{2}$

Response

Successful response

success
boolean
required