API docs by Redocly

Group Subgroups API (1.0.0)

Download OpenAPI specification:

API documentation for managing subgroups.

Subgroups

Returns list of subgroups of current group

Returns list of subgroups of current group.

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The group ID (Must be a positive unsigned integer)

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Creates a subgroup of the authenticated group

Creates a subgroup of the authenticated group. The authenticated group must be a top-level group, since nested subgroups are not allowed.

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The group ID

Request Body schema: application/json
required
name
required
string
type
required
string
relationship
required
string

Responses

Request samples

Content type
application/json
{
  • "name": "my-subgroup",
  • "type": "RESELLER",
  • "relationship": "MEMBER"
}

Update a subgroup's name and/or relationship

Update a subgroup's name and/or relationship. At least one field must be provided. The authenticated group must be a top-level group and the direct parent of the subgroup.

Important: Group type is intentionally not editable through this endpoint.

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The parent group ID

subgroup_id
required
integer

The child subgroup ID to update

Request Body schema: application/json
required
name
string
relationship
string

Responses

Request samples

Content type
application/json
{
  • "name": "Updated Subgroup Name",
  • "relationship": "CUSTOMER"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Subgroup updated successfully"
}

Disassociate a subgroup from its parent group

Disassociate a subgroup from its parent group, turning the disassociated subgroup to a top-level group.

Required Permissions:

  • GROUP_OWNER role
Authorizations:
BearerAuth
path Parameters
group_id
required
integer

The parent group ID

subgroup_id
required
integer

The child subgroup ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Subgroup disconnected successfully"
}