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

Request

  • Base URL: https://carbonarc.ai (the document declares no server; this is the origin it was published from)
  • URL: https://carbonarc.ai/api/v1/groups/{group_id}/block-role
  • Auth: OAuth 2 (authorization code, authorization URL authorize, token URL token)

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

unknown required

Changes

No recorded changes to this operation across all 4 revisions of this API.