Skip to main content
POST
/
teams
/
invite
Invite Team Member
curl --request POST \
  --url https://api.rolla.xyz/api/v1/external/teams/invite \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "jane@example.com",
  "fullname": "Jane Doe",
  "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "message": "Invitation sent successfully",
  "data": {
    "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email": "jsmith@example.com",
    "fullname": "<string>",
    "isNewUser": true
  }
}
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

curl -X POST "https://api.rolla.xyz/api/v1/external/teams/invite" \
  -H "X-API-Key: your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "jane@example.com",
    "fullname": "Jane Doe",
    "roleId": "e5f6a7b8-c9d0-1234-efgh-567890123456"
  }'

​
Example Response

{
  "success": true,
  "message": "Invitation sent successfully",
  "data": {
    "userId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "email": "jane@example.com",
    "fullname": "Jane Doe",
    "isNewUser": true
  }
}
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