Skip to main content
POST
Invite a user to the company
Invites a new user by email and assigns their role. The user receives an invitation link to complete their registration. Concept guide: Getting started with Fundflow
Requires the COMPANY_ADMIN role (the manage:company-users scope).

Authorizations

Authorization
string
header
required

OAuth2 authentication via Venly Identity Platform

Body

application/json

Request to invite a new user to join the company with a specified role

email
string<email>
required

Email address of the user to invite

Minimum string length: 1
Example:

"user@example.com"

role
enum<string>
required

Role to assign to the user:

  • COMPANY_ADMIN: Full access including user management
  • COMPANY_MANAGER: Can create and manage ramp requests
  • COMPANY_VIEWER: Read-only access
Available options:
COMPANY_ADMIN,
COMPANY_VIEWER,
COMPANY_MANAGER
firstName
string
required

First name of the user

Example:

"John"

lastName
string
required

Last name of the user

Example:

"Doe"

Response

User invitation successfully sent

success
boolean
default:true
result
object

Company user details