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

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

Permission to run the request: Account Owner, Administrator, Organization Administrator. 

 

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

Text
Description
Unknown userThe specified user hasn't been found.
Unknown groupThe specified group hasn't been found.
Permission DeniedYou do to have permission to edit the specified group info.
User not a group's memberA given user does not belong to the specified group.
Wrong parametersThe system failed to process the request, because it did not contain all necessary parameters.

 

Sample Call

Sample Response

 

  •