deleteGroup method

Future<DynamiteResponse<GroupsDeleteGroupResponseApplicationJson, void>> deleteGroup({
  1. required String groupId,
  2. bool? oCSAPIRequest,
})

Delete a group.

This endpoint requires admin access.

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.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Group deleted successfully

See:

Implementation

Future<DynamiteResponse<GroupsDeleteGroupResponseApplicationJson, void>> deleteGroup({
  required String groupId,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = deleteGroupRaw(
    groupId: groupId,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}