Clerk API (unofficial showcase)
POST/blocklist_identifiers

Add identifier to the block-list

Create an identifier that is blocked from accessing an instance

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 body field
identifierstringrequired
The identifier to be added in the block-list. This can be an email address, a phone number, or a web3 wallet.

4 status codes
200Success
objectstringoptional
String representing the object's type. Objects of the same type share the same value.
Allowed:blocklist_identifier
idstringoptional
identifierstringoptional
An email address, email domain, phone number or web3 wallet.
identifier_typestringoptional
Allowed:email_addressphone_numberweb3_wallet
instance_idstringoptional
created_atintegeroptional
Unix timestamp of creation
updated_atintegeroptional
Unix timestamp of last update.
400Request was not successful
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
402Payment required
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 400 is returned: Request was not successful. A 402 is returned: Payment required. A 422 is returned: Invalid request parameters.