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

You can remove a user from a group with the removeUserFromGroup method.

Parameters

ParameterTypeDescription
credentials (required)credentialsRead the description of the Credentials object.
groupId (required)stringID of the group, from which you want to delete the specified user.
userId (required)stringID of the user, whom you want to delete from the specified group.

 

Return Value

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

ParameterTypeDescription
successboolTrue, if a given user has been removed from 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 not a group’s memberA given user does not belong to this group.

 

Sample Call

Sample Response

 

  •