Skip to main content
POST
Invite a team member
A signed-in human administrator is required. API keys and MCP credentials cannot replace that session. Sensitive operations can also require recent authentication. Creates an invitation and revokes older unused invitations for the same email. Returns its token and inviteUrl once, and queues email if SMTP is configured. Request conventions · API keys · MCP connections

Authorizations

posted_session
string
cookie
required

Signed-in human browser session; mutation requests also need the exact UI Origin

Headers

Origin
string<uri>
required

The exact configured Posted UI origin. Required for browser mutations carrying session cookies.

Body

application/json
email
string<email>
required
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
required
Available options:
admin,
member,
viewer

Response

Successful response. Examples are illustrative; field values vary by record.

invitation
object
token
string
inviteUrl
string
emailDelivery
string