Skip to main content
POST
Create Invite

Authorizations

Authorization
string
header
required

A floo_ API key.

Headers

X-Floo-Org-Id
string<uuid>

Organization to act in; defaults to the one joined most recently.

Path Parameters

org_id
string<uuid>
required

Body

application/json

Request body for creating an org invite.

email
string<email>
required
role
enum<string>
default:member

Role of a user within an organization.

Available options:
admin,
member,
viewer

Response

Successful Response

Response after creating an invite — includes the one-time invite URL.

id
string<uuid>
required
org_id
string<uuid>
required
email
string
required
role
enum<string>
required

Role of a user within an organization.

Available options:
admin,
member,
viewer
status
enum<string>
required

Lifecycle status of an org invite.

Available options:
pending,
accepted,
revoked
invited_by_id
string<uuid> | null
required
expires_at
string<date-time>
required
created_at
string<date-time>
required
invite_url
string
required