Skip to main content
POST
/
api
/
v1
/
engagements
cURL
curl -sS -X POST "$FLUIDE_BASE_URL/api/v1/engagements" \
  -H "Content-Type: application/json" \
  -d '{}'
{
  "success": true,
  "message": "Operation completed successfully",
  "data": {}
}

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