Accept an invitation

POST

auth

invitations

Error

A valid request URL is required to generate request examples

{
  "id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "slug": "acme",
  "name": "Acme Inc",
  "metadata": {},
  "role": "owner",
  "created_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.

Body

application/json

token

string

required

The invitation token from the email.

Response

Success.

string

required

Unique identifier.

slug

string

required

name

string

required

The name.

metadata

object

required

Free-form metadata attached by the application.

role

string

required

created_at

string<date-time>

required

When it was created (UTC).

Error

A valid request URL is required to generate request examples

{
  "id": "01M5Y1G7AF0N78A9EP71BV68MT",
  "slug": "acme",
  "name": "Acme Inc",
  "metadata": {},
  "role": "owner",
  "created_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

Accept an invitation

Authorizations

Body

Response