latestOpenAPI 3.0.32026-08-12367267.0 KB

cda4b2b11372

Create a new group

Creates a new user group under the specified company. A group can be used to manage permissions, assign sessions, or organize users.

Parameters:

  • companyKey (string, required) - The company's secret key.
  • name (string, required) – The name of the new group.
  • memberIds (array of strings, optional) – A list of user IDs to be added to the group.
  • description (string, optional) – A description of the new group.
post/make-group

Request body

companyKeystring
namestring
memberIdsstring[]
descriptionstring

Example request

{
  "companyKey": "your-company-secret-key",
  "name": "GroupName",
  "memberIds": [
    "user1_id",
    "user2_id"
  ],
  "description": "GroupDescription"
}

Response

Success

Example response

{
  "result": {
    "id": "groupId"
  }
}