Create Clerk invitations

Invite one or more email addresses to sign up for a connected Clerk application.

← All Clerk endpoints · Capability overview

POST/v1/clerk/invitations

https://api.vee3.io/v1/clerk/invitations

10 tokens

Invite one or more email addresses to sign up for 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_invitations

Parameters2 fields

clerk_instance_idstringOptional

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

invitationsarrayRequired

One or more invitation objects. Each item requires email_address (string). Optional fields per item: role (string), redirect_url (string), public_metadata (object).

Response6 fields

invitationsarrayitems

5 fields

Created Clerk invitation summaries.

idstring

Clerk invitation id (inv_...).

email_addressstring

Email address the invitation was sent to.

statusstring

Invitation status: "pending", "accepted", "revoked", or "expired".

created_atinteger

Unix timestamp in milliseconds when the invitation was created.

revokedboolean

Whether the invitation has been revoked.

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/invitations"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
}
payload = {
    "invitations": [{"email_address":"ada@example.com","role":"org:member"}]
}

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

Example responses1 example

200Newly created Clerk invitations.

created_invitations.json

{
  "invitations": [
    {
      "id": "inv_2abc123",
      "email_address": "ada@example.com",
      "status": "pending",
      "created_at": 1710000000000,
      "revoked": false
    }
  ]
}