latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

User APIs

users

Update User Block Role

Set or clear the additive Block role (block_user / block_admin) on a user. block_role = null unsets it. The enum type on the DB column rejects any value outside the two valid enum members, so no extra application-level validation is needed.

put/api/v1/users/{user_id}/block-role

Path parameters

user_idstring uuid required

Request body

block_role'block_user' | 'block_admin'

Additive Block role values stored directly on users.block_role and groups.block_role (block_role_enum Postgres enum). Matches the snake_case value set used elsewhere in the Block domain.

Response

Successful Response

{"stackTrail":"paths:/api/v1/users/{user_id}/block-role:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}