Skip to main content
POST
Switch a member to manual allowance management

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
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 member is managed manually (inclusive), in YYYY-MM-DD format.

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

Why the member is managed manually — stored in the rule audit log.

Required string length: 3 - 500
valid_until
string | null

Last day of manual management (inclusive), in YYYY-MM-DD format, or null for open-ended.

Pattern: ^\d{4}-\d{2}-\d{2}$
current_assignment_id
integer | null

The assignment that is active today, from GET /members/{member_id}/rule-assignments. Send null when the member has none.

Required range: -9007199254740991 <= x <= 9007199254740991

Response

Successful response

success
boolean
required