Waitlist
The Waitlist object provides methods and properties to manage waitlist entries in your application. It's useful for building a instead of using the prebuilt <Waitlist /> component.
Properties
- Name
id- Type
string | undefined- Description
The unique identifier for the waitlist entry.
undefinedif the user has not joined the waitlist yet.
- Name
createdAt- Type
Date | null- Description
The date and time the waitlist entry was created.
nullif the user has not joined the waitlist yet.
- Name
updatedAt- Type
Date | null- Description
The date and time the waitlist entry was last updated.
nullif the user has not joined the waitlist yet.
Methods
join()
Submits an email address to join the waitlist. This method creates a new waitlist entry for the provided email address.
function join(params: JoinWaitlistParams): Promise<{ error: unknown }>- Name
emailAddress- Type
string- Description
The email address to add to the waitlist.
await clerk.waitlist.join({ emailAddress: 'test@example.com' })Feedback
Last updated on