Invite a tenant user
curl --request POST \
--url https://api.example.com/admin/tenants/{tenant_id}/invite \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"role_profile_key": "org_admin"
}
'import requests
url = "https://api.example.com/admin/tenants/{tenant_id}/invite"
payload = {
"email": "<string>",
"role_profile_key": "org_admin"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', role_profile_key: 'org_admin'})
};
fetch('https://api.example.com/admin/tenants/{tenant_id}/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.example.com/admin/tenants/{tenant_id}/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' => '<string>',
'role_profile_key' => 'org_admin'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/admin/tenants/{tenant_id}/invite"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/admin/tenants/{tenant_id}/invite")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/tenants/{tenant_id}/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Staff Onboarding
Invite a tenant user
Requires onboarding_admin + CSRF. Creates a tenant_invitations row (7-day expiry) and enqueues an encrypted send_email platform job carrying the invitation link — the invite is queued for asynchronous delivery, not sent synchronously. Returns 201 with the queued email job’s id.
POST
/
admin
/
tenants
/
{tenant_id}
/
invite
Invite a tenant user
curl --request POST \
--url https://api.example.com/admin/tenants/{tenant_id}/invite \
--header 'Content-Type: application/json' \
--data '
{
"email": "<string>",
"role_profile_key": "org_admin"
}
'import requests
url = "https://api.example.com/admin/tenants/{tenant_id}/invite"
payload = {
"email": "<string>",
"role_profile_key": "org_admin"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({email: '<string>', role_profile_key: 'org_admin'})
};
fetch('https://api.example.com/admin/tenants/{tenant_id}/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.example.com/admin/tenants/{tenant_id}/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' => '<string>',
'role_profile_key' => 'org_admin'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.example.com/admin/tenants/{tenant_id}/invite"
payload := strings.NewReader("{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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.example.com/admin/tenants/{tenant_id}/invite")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/admin/tenants/{tenant_id}/invite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"<string>\",\n \"role_profile_key\": \"org_admin\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}⌘I