Create organization invite

Creates a pending organization invite for an email address and returns the one-time invite token used by the onboarding flow.

Authorization

patAuth

PAT<token>

Personal Access Token

In: header

Path Parameters

orgId*string

Request Body

application/json

email*string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

workspaceRole?string

Value in"workspace_admin" | "workspace_user"

workspaceId?string

expiresInHours?integer

Range1 <= value <= 336

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/orgs/string/invites" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'

curl -X POST "https://loading/api/orgs/string/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com"  }'

{
  "invite": {
    "$id": "string",
    "organizationId": "string",
    "email": "user@example.com",
    "normalizedEmail": "string",
    "inviteTokenHash": "string",
    "status": "pending",
    "workspaceRole": "workspace_admin",
    "workspaceId": "string",
    "invitedByUserId": "string",
    "expiresAt": "string",
    "acceptedByUserId": "string",
    "acceptedAt": "string"
  },
  "inviteToken": "string",
  "organizationId": "string"
}

Empty