Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Access token JWT. Use as Authorization: Bearer . In the API playground, paste the JWT only.

X-Fluide-Api-Key
string
header
default:fl_dev_your_key
required

Developer API key (fl_dev_...). Required on every API call with a machine access token.

X-Fluide-Client-Id
string
header
default:fluide-developer
required

First-party client audience. Must match the fluide_client_id claim on the JWT. Use fluide-developer for Connect.

Path Parameters

portfolioId
string
required

portfolioId identifier

Body

application/json
businessOrganizationId
string<uuid>
required

Business organization id (kind = BUSINESS).

businessCompanyId
string<uuid>

Optional company id under the business.

instrumentType
enum<string>
Available options:
EQUITY,
DEBT,
SAFE,
CONVERTIBLE,
GRANT,
REVENUE_BASED
inviteMessage
string
Maximum string length: 1000
scopeFacs
boolean
scopeOperations
boolean
scopeFinancials
boolean
scopeDataRoom
boolean

Response

Invite — created

success
boolean
required

Whether the request succeeded

Example:

true

message
string
required

Human-readable outcome message (localized when i18n is configured)

Example:

"Operation completed successfully"

data
object

Endpoint-specific payload