latestOpenAPI 3.1.02026-08-218667571.2 MB

a8ca30023371

User APIs

groups

Update Group Block Role

Set or clear a group's additive Block role (block_user / block_admin).

Reuses the UserBlockRoleUpdate schema because the shape is identical — both set block_role on their entity. The Postgres enum rejects unknown values, so no extra validation is needed.

patch/api/v1/groups/{group_id}/block-role

Path parameters

group_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/groups/{group_id}/block-role:patch:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}