Create an organization-creation invite token
Creates a single organization-creation invite token. The token can be
redeemed exactly once via POST /organizations with the X-Invite-Token
header set, to create a new organization on the fly. To mint a batch
(e.g. for an outreach campaign), call this endpoint once per token —
the operation is independent per call so per-invite settings (boundEmail,
expiresAt) can vary freely.
Authorization: Requires the system-level can_create_organization permission.
Body fields: only boundEmail and expiresAt are honored. Server defaults
apply when omitted (open invite; 30-day expiry; server caps at 90 days).
Tokens are short, case-insensitive signup codes (e.g. ABCDE-FGHJK) — they
are the natural id used for all subsequent reads and revocations.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
An organization-creation invite token. Tokens are short, case-insensitive
signup codes (e.g. ABCDE-FGHJK) — they are the natural id for the
resource and are returned by all reads.
Optional. If set, restricts redemption to a caller with this email
(case-insensitive). Leave unset for open invites — typical for outreach
campaigns. Honored on POST /invites; immutable thereafter.
ISO 8601 timestamp at which the invite expires. On POST /invites,
defaults to now + 30 days; server caps at now + 90 days. Immutable
thereafter.
Response
Invite created successfully. The response includes the raw token.
An organization-creation invite token. Tokens are short, case-insensitive
signup codes (e.g. ABCDE-FGHJK) — they are the natural id for the
resource and are returned by all reads.
The invite token (e.g. ABCDE-FGHJK). Use in the redemption URL
https://{signupHost}/?token={token} and as the path id for
GET /invites/{token} / DELETE /invites/{token}.
Optional. If set, restricts redemption to a caller with this email
(case-insensitive). Leave unset for open invites — typical for outreach
campaigns. Honored on POST /invites; immutable thereafter.
ISO 8601 timestamp at which the invite expires. On POST /invites,
defaults to now + 30 days; server caps at now + 90 days. Immutable
thereafter.
Email of the system admin who created the invite.
ISO 8601 timestamp indicating when the invite was created.
ISO 8601 timestamp indicating when the invite was redeemed (null if unconsumed).
Email of the user who redeemed the invite (null if unconsumed).
Name of the organization created on redemption (null if unconsumed).