Page tree
Skip to end of metadata
Go to start of metadata

You can update a group with the updateGroup method.

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringID of the group that you want to update.
name (required)stringA name of the specified group.
description (required)stringA description of the specified group.
users (optional)string[]An array of user IDs to be added to the group.

 

Return Value

After the request has been completed, the system returns an object with the following properties.

ParameterTypeDescription
successboolTrue, if the group has been updated.
excessUsersstringAn array of IDs of users, who haven't been added to the group.

 

Possible Errors

ErrorDescription
duplicated group nameA group with this name already exists.
unknown groupA group with this name hasn't been found.

 

Sample Call

Sample Response

  •