Create Clerk invitation

Invite an email address 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 an email address 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_invitation

Parameters5 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 invite.

rolestringOptional

Optional role to assign when the invitation is accepted.

redirect_urlstringOptional

Optional URL to redirect the invitee to after accepting.

public_metadataobjectOptional

Optional public metadata as a JSON object attached to the invitation.

Response6 fields

invitationobject

5 fields

Created Clerk invitation object from the Backend API.

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 = {
    "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 Clerk invitation.

created_invitation.json

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