deleteAllowlistIdentifier()

Deletes an allowlist identifier.

Returns the DeletedObject object.

function deleteAllowlistIdentifier(allowlistIdentifierId: string): Promise<DeletedObject>

Parameters

• Name: allowlistIdentifierId
  Type: string
  Description: The ID of the allowlist identifier to delete.

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 allowlistIdentifierId = 'alid_123'

const response =
  await clerkClient.allowlistIdentifiers.deleteAllowlistIdentifier(allowlistIdentifierId)

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint DELETE/allowlist-identifiers/{identifier_id}. See the BAPI reference⁠ for more information.