Skip to main content
POST
Invite a member

Authorizations

X-API-Key
string
header
required

Path Parameters

org_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Body

application/json

Request schema for inviting a member to an organization.

email
string
required

Email address of the user to invite.

role
enum<string>
default:editor

Role to assign to the new member.

Available options:
owner,
manager,
billing,
editor

Response

OK

Response schema for a newly created organization invite (C-3818).

Returned instead of a Membership — invites are pending-until-redeemed (C-3895/C-3896), so a successful call no longer means the invitee has access yet. invite_url embeds the one-time raw token and is only ever available in this response — it is never persisted (only its hash is), so it cannot be recovered afterward. Capture and deliver it now.

id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
invited_email
string
required

Email address the invite was sent to.

role
enum<string>
required

Role that will be granted on acceptance.

Available options:
owner,
manager,
billing,
editor
role_display
string
required

Human-readable label for the role (localized).

status
string
required

Invite lifecycle status: pending, accepted, awaiting_approval, denied, expired, or revoked.

expires_at
string<date-time>
required

Instant after which the invite can no longer be redeemed.

invite_url
string
required

One-time acceptance link for the invitee. Only available in this response — capture and deliver it now.