Skip to main content
Docs

invite()

Invites a waitlist entry by ID. Returns a WaitlistEntry representing the invited entry.

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

Parameters

invite() accepts the following parameters:

  • Name
    id
    Type
    string
    Description

    The ID of the waitlist entry to invite.

  • Name
    params
    Type
    WaitlistEntryInviteParams
    Description

    An object representing additional parameters for the invitation.

WaitlistEntryInviteParams

  • Name
    ignoreExisting?
    Type
    boolean
    Description

    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

Note

Using clerkClient varies based on your framework. Refer to the JS Backend SDK overviewClerk Icon for usage details, including guidance on how to access the userId and other propertiesClerk Icon.

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 for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub