Invite someone by email

POST

auth

orgs

{slug}

invitations

Error

A valid request URL is required to generate request examples

{
  "id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "email": "grace@example.com",
  "role": "member",
  "expires_at": "2026-10-27T09:30:00+00:00"
}

Authorizations

apikey

string

header

required

Your publishable (pb_pk_…) or secret (pb_sk_…) key.

Authorization

string

header

required

The signed-in person's access token.

Path Parameters

slug

string

required

Body

application/json

string

required

Who to invite.

role

string

default:member

The role they join with.

redirect_to

string | null

Where the link in the email should send the person afterwards. Must be an allowed redirect URL for this environment.

Response

Created. The body is the new object.

string

required

Unique identifier.

string<email>

required

Email address.

role

string

required

expires_at

string<date-time>

required

When it stops being valid.

Error

A valid request URL is required to generate request examples

{
  "id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "email": "grace@example.com",
  "role": "member",
  "expires_at": "2026-10-27T09:30:00+00:00"
}

Storage

AI

Flows

Inbound webhooks

Health

Accounts and sign-in

Social sign-in

Company sign-in (SAML)

Two-step verification

Sessions

Organizations and teams

User API keys

Devices

Realtime

Invite someone by email

Authorizations

Path Parameters

Body

Response