Update a Compliance User Group

Updates a compliance user group information. Released in 1.55.3

Update user group informations

PUTyourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}

Path parameters

groupId*string

Header parameters

Body

application/json

namestring

Group name

areastring

Group area

descriptionstring

Group description

activeboolean

Group status

Response

200400401403404422500

Success

Body

application/json

idstring

Group ID

namestring

Group name

areastring

An optional string attribute used for categorizing groups

descriptionstring

Group description

typestring

Group type

activeboolean

Group status

createdDateinteger (int64)

Date of group creation

modifiedDateinteger (int64)

Date of group last update

memberCountinteger (int64)

Number of group members

assigneeCountinteger (int64)

Number of group assignees

Request

JavaScriptCurlPython

const response = await fetch('yourpodURL.symphony.com/pod/v2/admin/usergroups/{groupId}', {
    method: 'PUT',
    headers: {
      "sessionToken": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400401403404422500

{
  "id": "text",
  "name": "text",
  "area": "text",
  "description": "text",
  "type": "text",
  "active": false
}

🚧 Roles and Privileges

Calling this endpoint requires the Scope Management role with the MANAGE_ROLE_SCOPES entitleable action. See Bot Permissions for a list of roles and associated privileges.