Skip to main content
Docs

createAllowlistIdentifier()

Adds a new identifier to the allowlist. Returns the created AllowlistIdentifier object.

function createAllowlistIdentifier(
  params: AllowlistIdentifierCreateParams,
): Promise<AllowlistIdentifier>

AllowlistIdentifierCreateParams

  • Name
    identifier
    Type
    string
    Description

    The identifier to be added in the allowlist. Can be an email address, a phone number in international E.164 format, a domain, or a Web3 wallet address.

  • Name
    notify
    Type
    boolean
    Description

    Whether the given identifier will receive an invitation to join the application. Note that this only works for email address and phone number identifiers. Not available for wildcard identifiers or Web3 wallet addresses. Defaults to true.

Example

Note

Importing clerkClient varies based on your framework. Refer to the JS Backend SDK overview for usage details, including guidance on how to access the userId and other properties.

const response = await clerkClient.allowlistIdentifiers.createAllowlistIdentifier({
  identifier: 'test@example.com',
  notify: false,
})

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/allowlist-identifiers. See the BAPI reference for more information.

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on