Skip to main content

Invite User (Admin)

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

NameTypeDefaultDescription
email Requiredstring-Email address to invite. RFC 5322. Lower-cased server-side.
role Requiredstring-Role granted to the user upon accepting the invitation. One of: "member" (standard user — can run tools and view org data) or "admin" (org administrator — can also manage users, integrations, and API keys). This is the org-level role, distinct from the API-key scope that gated this call.
namestring-Optional display name for the invitee.

Use Cases

  • Onboard a new teammate to the org — send them a member invitation
  • Grant a colleague org-admin rights so they can manage users, integrations, and API keys
  • Re-send / fetch the active invitation for an email — the call is idempotent

Example Usage

Invite a standard member

{
"tool": "admin_invite_user",
"arguments": {
"email": "teammate@acme.com",
"role": "member"
}
}

Invite an org admin with a display name

{
"tool": "admin_invite_user",
"arguments": {
"email": "lead@acme.com",
"role": "admin",
"name": "Alex Lead"
}
}

Response Format

FieldTypeDescription
invitationIdstringUUID of the created (or existing, when idempotent) invitation.
emailstringLower-cased email the invitation was sent to.
rolestringOrg-level role granted on acceptance.
expiresAtstringWhen the invitation expires.