Docs

deleteAllowlistIdentifier()

Deletes an allowlist identifier, given a valid ID.

function deleteAllowlistIdentifier: (allowlistIdentifierId: string) => Promise<AllowlistIdentifier>;
  • Name
    allowlistIdentifierId
    Type
    string
    Description

    The ID of the allowlist identifier to delete.

const allowlistIdentifierId = 'alid_2b3VjS02AsRMoTcyLzMJ7mZvz4J';

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

console.log(response);
/*
DeletedObject {
  object: 'allowlist_identifier',
  id: 'alid_2b3VjS02AsRMoTcyLzMJ7mZvz4J',
  slug: null,
  deleted: true
}
*/

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 details.

Feedback

What did you think of this content?