Skip to main content
POST
Invite Team Member
Send an invitation to a new team member via email. If the user already has a Rolla account, they will be added directly. New users will receive a registration link.

Example Request

Example Response

The roleId is optional and defaults to the Initiator role when omitted. Use /teams/roles to get available role IDs — the assignable set is initiator, approver, and business_admin (the approver and business_admin roles can only be assigned by Business Owners and Business Admins). The roleId UUID model itself is unchanged.

Authorizations

X-API-Key
string
header
required

Your Rolla API key

Body

application/json
email
string<email>
required

Email address of the person to invite

Example:

"jane@example.com"

fullname
string
required

Full name of the person to invite

Required string length: 1 - 100
Example:

"Jane Doe"

roleId
string<uuid>

Role to assign (from /teams/roles). Optional — defaults to the initiator role when omitted.

Response

Invitation sent successfully

success
boolean
Example:

true

message
string
Example:

"Invitation sent successfully"

data
object