Skip to main content
POST
Create an organization-creation invite token

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

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.

boundEmail
string

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.

expiresAt
string<date-time>

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.

token
string
read-only

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}.

boundEmail
string

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.

expiresAt
string<date-time>

ISO 8601 timestamp at which the invite expires. On POST /invites, defaults to now + 30 days; server caps at now + 90 days. Immutable thereafter.

createdBy
string
read-only

Email of the system admin who created the invite.

createdAt
string<date-time>
read-only

ISO 8601 timestamp indicating when the invite was created.

consumedAt
string<date-time>
read-only

ISO 8601 timestamp indicating when the invite was redeemed (null if unconsumed).

consumedBy
string
read-only

Email of the user who redeemed the invite (null if unconsumed).

consumedOrganizationName
string
read-only

Name of the organization created on redemption (null if unconsumed).