Endpoint for managing user groups
Model used for UserGroups
GET /v1/usergroups/{uid} HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
OK
{ "Created": "2025-05-09T12:48:50.501Z", "LastModified": "2025-05-09T12:48:50.501Z", "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 } ] }
DELETE /v1/usergroups/{uid} HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
No content
GET /v1/usergroups HTTP/1.1 Host: Authorization: YOUR_API_KEY Accept: */*
[ { "Created": "2025-05-09T12:48:50.501Z", "LastModified": "2025-05-09T12:48:50.501Z", "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 } ] } ]
Model for creating a user group
Unique identifier for the user group
Name of the user group
Languages that the user group has access to
Segments that the user group has access to
Business units that the user group has access to
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 } ] }
Update model for a user group
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 } ] }