Skip to content
SupaCloud Docs
Select themeSelect language

POST /organization/invites — invite an email to the organization.

POST
/api/organization/invites
curl --request POST \
  --url https://example.com/api/organization/invites \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "message": "example", "preferred_locale": "example", "role": "example", "seat_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "target_workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "workspace_role": "example" }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string
message
string | null
preferred_locale
string | null
role
string
seat_type_id
string | null format: uuid
target_workspace_id
string | null format: uuid
workspace_role
string | null
Examplegenerated
{
  "email": "example",
  "message": "example",
  "preferred_locale": "example",
  "role": "example",
  "seat_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "target_workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_role": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Spec-only projection of one org invite row — the response deliberately OMITS the opaque accept token (see [invite_response]). The OrganizationInvite persistence model has no ToSchema derive; this mirrors the emitted wire shape.

object
accepted_at
string | null format: date-time
created_at
required
string format: date-time
email
required
string
expires_at
required
string format: date-time
id
required
string format: uuid
invited_by
required
string format: uuid
message
string | null
org_role
required
string
organization_id
required
string format: uuid
preferred_locale
required

The invite’s locale — the persistence model is non-null, so this is a plain (required, never-null) string.

string
resend_count
required
integer format: int32
revoked_at
string | null format: date-time
seat_type_id
string | null format: uuid
status
required
string
target_workspace_id
string | null format: uuid
workspace_role
string | null
Examplegenerated
{
  "accepted_at": "2026-04-15T12:00:00Z",
  "created_at": "2026-04-15T12:00:00Z",
  "email": "example",
  "expires_at": "2026-04-15T12:00:00Z",
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "invited_by": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "message": "example",
  "org_role": "example",
  "organization_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "preferred_locale": "example",
  "resend_count": 1,
  "revoked_at": "2026-04-15T12:00:00Z",
  "seat_type_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "status": "example",
  "target_workspace_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "workspace_role": "example"
}