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

You can add a user to a group with the addUserToGroup method.

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringID of the group, to which a given user will be added.
userId (required)stringID of a user to be added to a specified group.

 

Return Value

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

ParameterTypeDescription
successboolTrue, if the user has been added to the group.

 

Possible Errors

ErrorDescription
unknown groupA group with the specified ID cannot be found.
unknown userA user with the specified ID cannot be found.
user already group’s memberA given user already belongs to a given group.

 

Sample Call

 

Sample Response

  •