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"
}
'import requests
url = "https://api.rolla.xyz/api/v1/external/teams/invite"
payload = {
"email": "jane@example.com",
"fullname": "Jane Doe",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'jane@example.com',
fullname: 'Jane Doe',
roleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.rolla.xyz/api/v1/external/teams/invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/teams/invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'jane@example.com',
'fullname' => 'Jane Doe',
'roleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/teams/invite"
payload := strings.NewReader("{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rolla.xyz/api/v1/external/teams/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/teams/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invitation sent successfully",
"data": {
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"fullname": "<string>",
"isNewUser": true
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}Teams
Invite Team Member
Sends an invitation to a new team member via email.
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"
}
'import requests
url = "https://api.rolla.xyz/api/v1/external/teams/invite"
payload = {
"email": "jane@example.com",
"fullname": "Jane Doe",
"roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
email: 'jane@example.com',
fullname: 'Jane Doe',
roleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.rolla.xyz/api/v1/external/teams/invite', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/teams/invite",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'email' => 'jane@example.com',
'fullname' => 'Jane Doe',
'roleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/teams/invite"
payload := strings.NewReader("{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.rolla.xyz/api/v1/external/teams/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/teams/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jane@example.com\",\n \"fullname\": \"Jane Doe\",\n \"roleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invitation sent successfully",
"data": {
"userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"fullname": "<string>",
"isNewUser": true
}
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}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
Your Rolla API key
Body
application/json
Email address of the person to invite
Example:
"jane@example.com"
Full name of the person to invite
Required string length:
1 - 100Example:
"Jane Doe"
Role to assign (from /teams/roles). Optional — defaults to the initiator role when omitted.
⌘I