Create Clerk waitlist entry

Add an email address to the waitlist in a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/waitlist-entries

https://api.vee3.io/v1/clerk/waitlist-entries

10 tokens

Add an email address to the waitlist in a connected Clerk application.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.create_waitlist_entry

Parameters3 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

email_addressstringRequired

Email address to add to the waitlist.

notifybooleanOptional

Whether to notify the user their email was added. Defaults to true.

Response7 fields

waitlist_entryobject

6 fields

Created or existing Clerk waitlist entry from the Backend API.

idstring

Waitlist entry id (wle_...).

email_addressstring

Email address on the waitlist.

statusstring

Waitlist status: "pending", "invited", "rejected", or "completed".

created_atinteger

Unix timestamp in milliseconds when the entry was created.

updated_atinteger

Unix timestamp in milliseconds when the entry was last updated.

is_lockedboolean

Whether the entry is locked during batch processing.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/waitlist-entries"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "email_address": "ada@example.com"
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Newly created waitlist entry.

created_waitlist_entry.json

{
  "waitlist_entry": {
    "id": "wle_2abc123",
    "email_address": "ada@example.com",
    "status": "pending",
    "created_at": 1710000000000,
    "updated_at": 1710000000000,
    "is_locked": false
  }
}