Sign in
Users

Create organization invitation

Invite a user to the organization by email. Requires org admin. Behavior:

  • If the email maps to an already-confirmed User, attach them as an OrgUser (and to any teamIds) immediately. The response includes a compact invite summary with status accepted and orgId set to the attached org; no invite row is inserted.

  • If the email maps to an unconfirmed User with a live pending invite for this org, return the existing invite with status sent. If the existing invite is canceled or expired, reactivate it with status sent.

  • Otherwise create the User row (with email_confirmed=false if missing), create a UserInvite row, send the invitation email, and return it with status sent.

Subject to a per-inviter cap of 10 pending invites. Every non-accepted invite within the invite TTL counts toward the cap.

post/internal/v1/orgs/{org_id}/invites

Path parameters

org_idinteger required

Organization ID.

Request body

emailstring required

Email address of the invitee. Required; trimmed and lowercased server-side.

role'owner' | 'admin' | 'member' | 'viewer' | 'billing_manager' | 'collaborator'

A user's role within an organization.

teamIdsinteger[]

Teams to add the invitee to on acceptance. Each team must belong to the URL org.

Response

Invitation created (email sent) or immediately accepted.

Changes

No recorded changes to this endpoint across all 1 revision of this API.