Click or drag to resize

GroupResourcesRemoveGroupMember Method

Removes a member from a Group.

Remarks

This operation is only available to group administrators and system administrators.

This operation is asynchronous, meaning group members may retain their sharing access for a brief period of time after the call returns. For small groups with limited sharing, the operation should complete quickly (within a few seconds). For large groups with many shares, this operation could possibly take more than a minute to complete.

It mirrors to the following Smartsheet REST API method: DELETE /groups/{groupId}/members/{userId}

Namespace:  Smartsheet.Api
Assemblies:   smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
  smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
Syntax
Copy
void RemoveGroupMember(
	long groupId,
	long userId
)

Parameters

groupId
Type: SystemInt64
the Id of the group
userId
Type: SystemInt64
the Id of the user
Exceptions
ExceptionCondition
InvalidOperationException if any argument is null or empty string
InvalidRequestException if there is any problem with the REST API request
AuthorizationException if there is any problem with the REST API authorization (access token)
ResourceNotFoundException if the resource cannot be found
ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
SmartsheetException if there is any other error during the operation
See Also