Skip to main content
POST
Bulk Create Invites

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 bulk-inviting multiple users at once.

emails
string<email>[]
required
Required array length: 1 - 100 elements
role
enum<string>
default:member

Role of a user within an organization.

Available options:
admin,
member,
viewer

Response

Successful Response

Response after a bulk invite call.

invited
integer
required
skipped
integer
required
failed
integer
required
results
BulkInviteResultEntry · object[]
required