Skip to main content

invite()

Invites the given waitlist entry.

Returns the invited WaitlistEntry object.

function invite(id: string, params: { ignoreExisting?: boolean }): Promise<WaitlistEntry>

Parameters

  • Name
    id
    Type
    string
    Description

    The waitlist entry ID.

  • Name
    params
    Type
    { ignoreExisting?: boolean; }
    Description

    Optional parameters for inviting the waitlist entry.

  • Name
    params.ignoreExisting?
    Type
    boolean
    Description

    Whether to ignore an existing invitation. Defaults to false.

Usage

Note

Using clerkClient varies based on the SDK you're using. Refer to the overview for usage details, including guidance on how to access the userId and other properties.

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