Skip to main content
Docs

delete()

Deletes a pending waitlist entry by ID. Returns a DeletedObjectResourceJavaScript Icon.

function delete(
  id: string,
): Promise<DeletedObjectResource>

Parameters

  • Name
    id
    Type
    string
    Description

    The ID of the waitlist entry to delete.

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.delete(waitlistId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/waitlist_entries/{waitlist_entry_id}. See the BAPI reference for more information.

Feedback

What did you think of this content?

Last updated on

GitHubEdit on GitHub