Document missing createInvitationBulk method on JS Backend SDK (#2668)

Author: SarahSoutoul

docs/manifest.json

@@ -2448,6 +2448,10 @@
                                 "title": "`createInvitation()`",
                                 "href": "/docs/reference/backend/invitations/create-invitation"
                               },
+                              {
+                                "title": "`createInvitationBulk()`",
+                                "href": "/docs/reference/backend/invitations/create-invitation-bulk"
+                              },
                               {
                                 "title": "`revokeInvitation()`",
                                 "href": "/docs/reference/backend/invitations/revoke-invitation"

docs/reference/backend/invitations/create-invitation-bulk.mdx

@@ -0,0 +1,111 @@
+---
+title: '`createInvitationBulk()`'
+description: Use Clerk's JS Backend SDK to create multiple invitations for the given email addresses, and send the invitation emails.
+sdk: js-backend
+---
+
+{/* clerk/javascript file: https://github.com/clerk/javascript/blob/main/packages/backend/src/api/endpoints/InvitationApi.ts#L69 */}
+
+Creates multiple [`Invitation`](/docs/reference/backend/types/backend-invitation)s in bulk for the given email addresses and sends the invitation emails.
+
+If an email address has already been invited or already exists in your application, trying to create a new invitation will return an error. To bypass this error and create a new invitation anyways, set `ignoreExisting` to `true`.
+
+```ts
+function createInvitationBulk(params: CreateBulkParams): Promise<Invitation[]>
+```
+
+## Parameters
+
+<Properties>
+  - `params`
+  - [`CreateBulkParams[]`](#create-bulk-params)
+
+  An array of objects, each representing a single invitation.
+</Properties>
+
+## `CreateBulkParams`
+
+<Properties>
+  - `emailAddress`
+  - `string`
+
+  The email address of the user to invite.
+
+  ---
+
+  - `redirectUrl?`
+  - `string`
+
+  The full URL or path where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a [custom flow for handling application invitations](/docs/guides/development/custom-flows/authentication/application-invitations).
+
+  ---
+
+  - `publicMetadata?`
+  - [`UserPublicMetadata`](/docs/reference/javascript/types/metadata#user-public-metadata)
+
+  Metadata that can be read from both the Frontend API and [Backend API](/docs/reference/backend-api){{ target: '_blank' }}, but can be set only from the Backend API. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata.
+
+  ---
+
+  - `notify?`
+  - `boolean`
+
+  Whether an email invitation should be sent to the given email address. Defaults to `true`.
+
+  ---
+
+  - `ignoreExisting?`
+  - `boolean`
+
+  Whether an invitation should be created if there is already an existing invitation for this email address, or if the email address already exists in the application. Defaults to `false`.
+
+  ---
+
+  - `expiresInDays?`
+  - `number`
+
+  The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
+
+  ---
+
+  - `templateSlug?`
+  - `'invitation' | 'waitlist_invitation'`
+
+  The slug of the email template to use for the invitation email. Defaults to `invitation`.
+</Properties>
+
+## Example
+
+<Include src="_partials/backend/usage" />
+
+```tsx
+// Each object in the array represents a single invitation
+const params = [
+  {
+    emailAddress: '[email protected]',
+    redirectUrl: 'https://www.example.com/my-sign-up',
+    publicMetadata: {
+      example: 'metadata',
+      example_nested: {
+        nested: 'metadata',
+      },
+    },
+  },
+  {
+    emailAddress: '[email protected]',
+    redirectUrl: 'https://www.example.com/my-sign-up',
+    publicMetadata: {
+      example: 'metadata',
+      example_nested: {
+        nested: 'metadata',
+      },
+    },
+  },
+]
+
+const response = await clerkClient.invitations.createInvitationBulk(params)
+```
+
+## Backend API (BAPI) endpoint
+
+This method in the SDK is a wrapper around the BAPI endpoint `POST/invitations/bulk`. See the [BAPI reference](/docs/reference/backend-api/tag/invitations/post/invitations/bulk){{ target: '_blank' }} for more information.

docs/reference/backend/invitations/create-invitation.mdx

@@ -49,6 +49,20 @@ function createInvitation(params: CreateParams): Promise<Invitation>
   - `boolean`
 
   Whether an invitation should be created if there is already an existing invitation for this email address, or if the email address already exists in the application. Defaults to `false`.
+
+  ---
+
+  - `expiresInDays?`
+  - `number`
+
+  The number of days the invitation will be valid for. By default, the invitation expires after 30 days.
+
+  ---
+
+  - `templateSlug?`
+  - `'invitation' | 'waitlist_invitation'`
+
+  The slug of the email template to use for the invitation email. Defaults to `invitation`.
 </Properties>
 
 ## Example