removeFromGroup method

Future<DynamiteResponse<UsersRemoveFromGroupResponseApplicationJson, void>> removeFromGroup({
  1. required String groupid,
  2. required String userId,
  3. bool? oCSAPIRequest,
})

Remove a user from a group.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • groupid ID of the group.
  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User removed from group successfully

See:

Implementation

Future<DynamiteResponse<UsersRemoveFromGroupResponseApplicationJson, void>> removeFromGroup({
  required String groupid,
  required String userId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = removeFromGroupRaw(
    groupid: groupid,
    userId: userId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}