Invite a Team Member
curl --request POST \
--url https://api.getnexor.ai/api/public/team/invite \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"invitee_name": "<string>",
"send_email": true,
"dry_run": false
}
'import requests
url = "https://api.getnexor.ai/api/public/team/invite"
payload = {
"email": "jsmith@example.com",
"invitee_name": "<string>",
"send_email": True,
"dry_run": False
}
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: 'jsmith@example.com',
invitee_name: '<string>',
send_email: true,
dry_run: false
})
};
fetch('https://api.getnexor.ai/api/public/team/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.getnexor.ai/api/public/team/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' => 'jsmith@example.com',
'invitee_name' => '<string>',
'send_email' => true,
'dry_run' => false
]),
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.getnexor.ai/api/public/team/invite"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\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.getnexor.ai/api/public/team/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/team/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\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": "already_member",
"email_sent": false
}{
"success": true,
"invitation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"email_sent": true
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Invite a Team Member
This operation lets you invite a team member for the authenticated Nexor account. This reference documents verified path, query, and top-level JSON body fields, observed response status codes, and top-level response fields. Provider-owned or deeply nested response shapes may remain open.
POST
/
team
/
invite
Invite a Team Member
curl --request POST \
--url https://api.getnexor.ai/api/public/team/invite \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"invitee_name": "<string>",
"send_email": true,
"dry_run": false
}
'import requests
url = "https://api.getnexor.ai/api/public/team/invite"
payload = {
"email": "jsmith@example.com",
"invitee_name": "<string>",
"send_email": True,
"dry_run": False
}
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: 'jsmith@example.com',
invitee_name: '<string>',
send_email: true,
dry_run: false
})
};
fetch('https://api.getnexor.ai/api/public/team/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.getnexor.ai/api/public/team/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' => 'jsmith@example.com',
'invitee_name' => '<string>',
'send_email' => true,
'dry_run' => false
]),
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.getnexor.ai/api/public/team/invite"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\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.getnexor.ai/api/public/team/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getnexor.ai/api/public/team/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\": \"jsmith@example.com\",\n \"invitee_name\": \"<string>\",\n \"send_email\": true,\n \"dry_run\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"status": "already_member",
"email_sent": false
}{
"success": true,
"invitation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "created",
"email_sent": true
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}{
"error": "<string>",
"message": "<string>",
"code": "<string>"
}Safety and behavior notes
- The operation creates a membership invitation and sends an external email by default.
- HTTP 200 has three distinct outcomes, separate from the HTTP 201 creation outcome; inspect the response fields.
- The invitation remains persisted when email delivery fails; inspect email_sent.
- send_email defaults to true.
- already_member and reused checks run before dry_run, so a dry run can return those statuses instead of status=dry_run, while still avoiding writes.
Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Body
application/json
Last modified on September 8, 2026
⌘I