Create group

Creates a new group in the current user’s organization

POST /api/v1/org/groups

Error

A valid request URL is required to generate request examples

200

{
  "results": {
    "organizationUuid": "<string>",
    "updatedByUserUuid": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdByUserUuid": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "uuid": "<string>",
    "memberUuids": [
      "<string>"
    ],
    "members": [
      {
        "lastName": "<string>",
        "firstName": "<string>",
        "email": "<string>",
        "userUuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ]
  },
  "status": "ok"
}

{
  "error": {
    "name": "<string>",
    "statusCode": 123,
    "data": "<unknown>",
    "message": "<string>"
  },
  "status": "error"
}

Body

application/json

the new group details

the new group details

name · string · required

A friendly name for the group

members · object[]

Show child attributes

Response

200

application/json

Ok

results · object · required

Details for a group including a list of the group's members.

Show child attributes

status · enum<string> · required

Available options: ok