Invite user to account
curl --request POST \
--url http://localhost:9001/api/v1/accounts/{account_id}/users/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "newuser@example.com"
}
'import requests
url = "http://localhost:9001/api/v1/accounts/{account_id}/users/invite"
payload = { "email": "newuser@example.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'newuser@example.com'})
};
fetch('http://localhost:9001/api/v1/accounts/{account_id}/users/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_PORT => "9001",
CURLOPT_URL => "http://localhost:9001/api/v1/accounts/{account_id}/users/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' => 'newuser@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:9001/api/v1/accounts/{account_id}/users/invite"
payload := strings.NewReader("{\n \"email\": \"newuser@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:9001/api/v1/accounts/{account_id}/users/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"newuser@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9001/api/v1/accounts/{account_id}/users/invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"newuser@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"message": "User invitation sent successfully"
}User
Invite User to Account
Invites a user to join the account by email.
For new users:
- Creates a user record with INVITED status
- Assigns team_member role for the account
- Sends an invitation email
For existing users:
- Validates they don’t belong to another account
- Assigns team_member role for the account
- No invitation email is sent (they can log in directly)
POST
/
api
/
v1
/
accounts
/
{account_id}
/
users
/
invite
Invite user to account
curl --request POST \
--url http://localhost:9001/api/v1/accounts/{account_id}/users/invite \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "newuser@example.com"
}
'import requests
url = "http://localhost:9001/api/v1/accounts/{account_id}/users/invite"
payload = { "email": "newuser@example.com" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'newuser@example.com'})
};
fetch('http://localhost:9001/api/v1/accounts/{account_id}/users/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_PORT => "9001",
CURLOPT_URL => "http://localhost:9001/api/v1/accounts/{account_id}/users/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' => 'newuser@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:9001/api/v1/accounts/{account_id}/users/invite"
payload := strings.NewReader("{\n \"email\": \"newuser@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:9001/api/v1/accounts/{account_id}/users/invite")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"newuser@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9001/api/v1/accounts/{account_id}/users/invite")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"newuser@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"message": "User invitation sent successfully"
}Authorizations
bearerAuthapiKeyAuth
JWT token from Auth0
Path Parameters
Account's external ID (format: acct-xxx-v1)
Example:
"acct-xyz789-v1"
Body
application/json
Email address of the user to invite
Example:
"newuser@example.com"
Response
Invitation sent successfully
Example:
"User invitation sent successfully"
⌘I
