Skip to main content
Creates an invitation and emails the invitee. One live invitation per email per team: if a pending one exists, revoke it first — re-inviting is revoke + create (there is no resend endpoint). Invitation emails expire after 7 days. Creation is capped per team per 24 hours; the cap counts created invitations, and 429 responses carry Retry-After.
Permission required: member:invite
  • Changes that give someone an admin role, or that reduce what an admin can reach, also require the team owner or an admin.

Headers

string
Optional. Retrying with the same value replays the first result instead of sending a second email.

Request Body

string
required
Invitee email address. One live invitation per address per team.
string
required
Role the invitee will hold on acceptance: tenant_admin, tenant_member, or a custom role key of this team. The owner role cannot be invited.

Response

object

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.