deleteAllowlistIdentifier()
Deletes an allowlist identifier, given a valid ID.
function deleteAllowlistIdentifier: (allowlistIdentifierId: string) => Promise<AllowlistIdentifier>;
deleteAllowlistIdentifier()
parameters
Name | Type | Description |
---|---|---|
allowlistIdentifierId | string | The ID of the allowlist identifier to delete. |
deleteAllowlistIdentifier()
example
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(opens in a new tab) for more details.
Last updated on August 16, 2023