addToGroup method

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

Add a user to 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. Defaults to ''.
  • userId ID of the user.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: User added to group successfully

See:

  • addToGroupRaw for an experimental operation that returns a DynamiteRawResponse that can be serialized.

Implementation

Future<_i1.DynamiteResponse<UsersAddToGroupResponseApplicationJson, void>> addToGroup({
  required String userId,
  String? groupid,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = addToGroupRaw(
    userId: userId,
    groupid: groupid,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}