Sign in
User APIs
groups

Create Group

Create new group

post/api/v1/groups/

Request body

namestring required
descriptionstring nullable
transaction_limitnumber nullable
allocated_amountnumber nullable
client_idstring uuid required
is_defaultboolean nullable
is_activeboolean nullable
meta_dataobject nullable
user_idsstring[] nullable
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/:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes