patchGroup method

Future<MmGroup?> patchGroup(
  1. String groupId,
  2. MmPatchGroupRequest mmPatchGroupRequest
)

Patch a group

Partially update a group by providing only the fields you want to update. Omitted fields will not be updated. The fields that can be updated are defined in the request body, all other provided fields will be ignored. ##### Permissions Must have manage_system permission. Minimum server version: 5.11

Parameters:

  • String groupId (required): Group GUID

  • MmPatchGroupRequest mmPatchGroupRequest (required): Group object that is to be updated

Implementation

Future<MmGroup?> patchGroup(
  String groupId,
  MmPatchGroupRequest mmPatchGroupRequest,
) async {
  final response = await patchGroupWithHttpInfo(
    groupId,
    mmPatchGroupRequest,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw MmApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'MmGroup',
    ) as MmGroup;
  }
  return null;
}