Function: inviteUsers()

function inviteUsers(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
}>;

Invite people to your organization. When you invite someone:

They’re given app roles according to your invitation.
They’re added to directories based on apps in your invitation.
They’re added to groups according to your invitation.
They receive an email invitation if the sendNotification field is set to true and the notificationText field contains a message to include in the email invitation.

This API is only available to customers who have at least one paid subscription in their organization.

Parameters

Parameter	Type	Description
`client`	`Client`	-
`parameters`	{ `additionalGroups?`: `string`[]; `emails`: `string`[]; `notificationText?`: `string`; `orgId`: `string`; `permissionRules?`: `object`[]; `sendNotification?`: `boolean`; }	-
`parameters.additionalGroups?`	`string`[]	The groups you want to add users to from this invitation. Use the Get groups in an organization endpoint to find the group IDs.
`parameters.emails?`	`string`[]	Email addresses of the people you want to invite.
`parameters.notificationText?`	`string`	Add a message to your email invitation.
`parameters.orgId?`	`string`	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
`parameters.permissionRules?`	`object`[]	The access you want to give users from this invitation.
`parameters.sendNotification?`	`boolean`	Set to true if you want to send an email invitation.
`options?`	`RequestOptions`	-

Promise<{ [key: string]: unknown; data?: object[]; }>