# invite()

Invites a waitlist entry by ID. Returns a [`WaitlistEntry`](https://clerk.com/docs/reference/backend/types/backend-waitlist-entry.md) representing the invited entry.

```ts
function invite(id: string, params: WaitlistEntryInviteParams): Promise<WaitlistEntry>
```

## Parameters

`invite()` accepts the following parameters:

| Name   | Type                      | Description                                                      |
| ------ | ------------------------- | ---------------------------------------------------------------- |
| id     | string                    | The ID of the waitlist entry to invite.                          |
| params | WaitlistEntryInviteParams | An object representing additional parameters for the invitation. |

## `WaitlistEntryInviteParams`

| Name            | Type    | Description                                                                                                                                                        |
| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| ignoreExisting? | boolean | Whether an invitation should be created if there is already an existing invitation for this email address, or has been claimed by another user. Defaults to false. |

## Example

> Using `clerkClient` varies based on the SDK you're using. Refer to the [overview](https://clerk.com/docs/reference/backend/overview.md) for usage details, including guidance on [how to access the `userId` and other properties](https://clerk.com/docs/reference/backend/overview.md#example-get-the-user-id-and-other-properties).

```tsx
const waitlistId = 'waitlist_123'

const response = await clerkClient.waitlistEntries.invite(waitlistId)
```

## Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint `POST/waitlist_entries/{waitlist_entry_id}/invite`. See the [BAPI reference](https://clerk.com/docs/reference/backend-api/tag/waitlist-entries/POST/waitlist_entries/%7Bwaitlist_entry_id%7D/invite){{ target: '_blank' }} for more information.

---

## Sitemap

[Overview of all docs pages](https://clerk.com/docs/llms.txt)