Invite Clerk waitlist entry

Send an invite to a waitlist entry email address.

← All Clerk endpoints · Capability overview

POST/v1/clerk/waitlist-entries/{waitlist_entry_id}/invite

https://api.vee3.io/v1/clerk/waitlist-entries/{waitlist_entry_id}/invite

10 tokens

Send an invite to a waitlist entry email address.

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.invite_waitlist_entry

Parameters3 fields

clerk_instance_idstringOptional

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

waitlist_entry_idstringRequired

Clerk waitlist entry id (wle_...) to operate on.

ignore_existingbooleanOptional

When true, create an invitation even if one already exists for this email.

Response7 fields

waitlist_entryobject

6 fields

Updated Clerk waitlist entry after inviting.

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/{waitlist_entry_id}/invite"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "waitlist_entry_id": "waitlist_entry_2abc123"
}

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

Example responses1 example

200Waitlist entry after sending an invite.

invited_waitlist_entry.json

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