addGroup method

Future<DynamiteResponse<GroupsAddGroupResponseApplicationJson, void>> addGroup({
  1. required String groupid,
  2. String? displayname,
  3. bool? oCSAPIRequest,
})

Create a new 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.
  • displayname Display name of the group. Defaults to ''.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Group created successfully

See:

Implementation

Future<DynamiteResponse<GroupsAddGroupResponseApplicationJson, void>> addGroup({
  required String groupid,
  String? displayname,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = addGroupRaw(
    groupid: groupid,
    displayname: displayname,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}