Skip to main content

Creates a user group

POST /v1/usergroup

Summary​

Creates a user group.

Details​

Request body: JSON object. This endpoint uses value as the group

name, sanitizes it to alphanumeric characters and spaces, truncates it to 100 characters, and rejects

duplicate group names for the same user.

Authentication​

No operation-level security requirement is documented here.

Parameters​

None documented here.

Request Body​

Required: Yes

application/json​

  • value (string, optional)

Example

{
  "value": "Example value"
}

Responses​

200​

Success

application/json​

  • key (integer (int64), optional)
  • collectionName (string, optional)
  • description (string, optional)
  • itemTypeID (integer (int64), optional)
  • itemID (integer (int64), optional)
  • parentID (integer (int64), optional)
  • creationDate (string (date-time), optional)

Example

{
  "key": 1,
  "collectionName": "Example value",
  "description": "Example description",
  "itemTypeID": 1,
  "itemID": 1,
  "parentID": 1,
  "creationDate": "2026-03-30T12:00:00.0000000Z"
}