inviteGuestsToTeamWithHttpInfo method

Future<Response> inviteGuestsToTeamWithHttpInfo(String teamId, MmInviteGuestsToTeamRequest mmInviteGuestsToTeamRequest)

Invite guests to the team by email

Invite guests to existing team channels usign the user's email. The number of emails that can be sent is rate limited to 20 per hour with a burst of 20 emails. If the rate limit exceeds, the error message contains details on when to retry and when the timer will be reset. Minimum server version: 5.16 ##### Permissions Must have invite_guest permission for the team.

Note: This method returns the HTTP Response.

Parameters:

• String teamId (required): Team GUID

• MmInviteGuestsToTeamRequest mmInviteGuestsToTeamRequest (required): Guests invite information

Implementation

Future<Response> inviteGuestsToTeamWithHttpInfo(
  String teamId,
  MmInviteGuestsToTeamRequest mmInviteGuestsToTeamRequest,
) async {
  // ignore: prefer_const_declarations
  final path = r'/teams/{team_id}/invite-guests/email'.replaceAll('{team_id}', teamId);

  // ignore: prefer_final_locals
  Object? postBody = mmInviteGuestsToTeamRequest;

  final queryParams = <MmQueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>['application/json'];

  return apiClient.invokeAPI(
    path,
    'POST',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}