UserGroup

Endpoint for managing user groups

Get all usersgroups in the tenant

get
Authorizations
Responses
200
OK
get
GET /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Created": "2025-06-27T08:36:24.130Z",
    "LastModified": "2025-06-27T08:36:24.130Z",
    "CreatedBy": "text",
    "LastModifiedBy": "text",
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Languages": [
      {
        "LanguageId": 1,
        "ReadOnly": true
      }
    ],
    "Segments": [
      {
        "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
        "ReadOnly": true
      }
    ],
    "BusinessUnits": [
      {
        "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
        "ReadOnly": true
      }
    ]
  }
]

Creates a new user group

post
Authorizations
Body

Model for creating a user group

Uidstring · uuidOptional

Unique identifier for the user group

Namestring | nullableOptional

Name of the user group

Responses
200
OK
post
POST /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 283

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}
No content

Updates a existing usergroup

put
Authorizations
Body

Update model for a user group

Uidstring · uuidOptional

Unique identifier for the user group

Namestring | nullableOptional

Name of the user group

Responses
200
OK
put
PUT /v1/usergroups HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 283

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}
No content

Returns a single usergroup from the tenant

get
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
get
GET /v1/usergroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Created": "2025-06-27T08:36:24.130Z",
  "LastModified": "2025-06-27T08:36:24.130Z",
  "CreatedBy": "text",
  "LastModifiedBy": "text",
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Name": "text",
  "Languages": [
    {
      "LanguageId": 1,
      "ReadOnly": true
    }
  ],
  "Segments": [
    {
      "SegmentUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ],
  "BusinessUnits": [
    {
      "BusinessUnitUid": "123e4567-e89b-12d3-a456-426614174000",
      "ReadOnly": true
    }
  ]
}

Deletes an existing usergroup

delete
Authorizations
Path parameters
uidstring · uuidRequired
Responses
200
OK
delete
DELETE /v1/usergroups/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content
PreviousTransactionsNextUserRoles