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.

Body

application/json
companyId
string<uuid>
required

Company under the calling business org that the VM will operate on.

engagementTypes
enum<string>
required

Module types covered by this engagement (min 1).

Available options:
HR,
PAYROLL,
BOOKS,
PAY
virtualManagerOrgId
string<uuid>

Target VM organization (verified). XOR with virtualManagerEmail.

virtualManagerEmail
string<email>

Invite by email — resolves an existing VM org or queues onboarding. XOR with virtualManagerOrgId.

engagementType
enum<string>
deprecated
Available options:
HR,
PAYROLL,
BOOKS,
PAY
endDate
string

Optional planned end date (ISO timestamp). Null = open-ended.

inviteMessage
string

Optional message shown to the VM in their inbox.

Maximum string length: 2000

Response

Create — 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