Allow-list / Block-list

Add identifier to the allow-list

Create an identifier allowed to sign up to an instance

post/allowlist_identifiers

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/allowlist_identifiers
  • Auth: HTTP bearer

Request body

identifierstring required

The identifier to be added in the allow-list. This can be an email address, a phone number, or a web3 wallet.

notifyboolean

This flag denotes whether the given identifier will receive an invitation to join the application. Note that this only works for email address and phone number identifiers.

Response

Success

object'allowlist_identifier'

String representing the object's type. Objects of the same type share the same value.

idstring
invitation_idstring
identifierstring

An email address or a phone number.

identifier_type'email_address' | 'phone_number' | 'web3_wallet'
instance_idstring
created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of last update.

Changes

No recorded changes to this operation across all 49 revisions of this API.