Invite user (admin)
Coming soon
The v2 MCP API is in preview and not yet generally available. These pages document its tools and request/response shapes; live data access is limited to enrolled organizations until v2 is released.
Invite a user to the calling org. Requires an admin-scoped API key. Idempotent: returns the existing invitation if one is already active for this email.
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | ✅ Yes | - | Email address to invite. RFC 5322. Lower-cased server-side. |
role | string | ✅ Yes | - | Role granted to the user upon accepting the invitation. |
name | string | ❌ No | - | Optional display name for the invitee. |