cURL
curl --request POST \
--url https://api.nekt.ai/api/v1/invitations/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"other_functional_area": "<string>"
}
'import requests
url = "https://api.nekt.ai/api/v1/invitations/"
payload = {
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"other_functional_area": "<string>"
}
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',
first_name: '<string>',
last_name: '<string>',
role: 'member',
other_functional_area: '<string>'
})
};
fetch('https://api.nekt.ai/api/v1/invitations/', 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.nekt.ai/api/v1/invitations/",
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',
'first_name' => '<string>',
'last_name' => '<string>',
'role' => 'member',
'other_functional_area' => '<string>'
]),
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.nekt.ai/api/v1/invitations/"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\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.nekt.ai/api/v1/invitations/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/invitations/")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"sent_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"picture": "<string>",
"role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"date_joined": "2023-11-07T05:31:56Z",
"last_login": "2023-11-07T05:31:56Z",
"is_active": false,
"is_pending": false,
"joined_at": "2023-11-07T05:31:56Z",
"workspace_is_active": true
},
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"functional_area": "data_analytics",
"other_functional_area": "<string>"
}Legacy
Invite User (legacy)
Invite one person to your organization, or resend their invitation, without workspaces.
POST
/
api
/
v1
/
invitations
/
cURL
curl --request POST \
--url https://api.nekt.ai/api/v1/invitations/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"other_functional_area": "<string>"
}
'import requests
url = "https://api.nekt.ai/api/v1/invitations/"
payload = {
"email": "jsmith@example.com",
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"other_functional_area": "<string>"
}
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',
first_name: '<string>',
last_name: '<string>',
role: 'member',
other_functional_area: '<string>'
})
};
fetch('https://api.nekt.ai/api/v1/invitations/', 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.nekt.ai/api/v1/invitations/",
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',
'first_name' => '<string>',
'last_name' => '<string>',
'role' => 'member',
'other_functional_area' => '<string>'
]),
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.nekt.ai/api/v1/invitations/"
payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\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.nekt.ai/api/v1/invitations/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.nekt.ai/api/v1/invitations/")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"role\": \"member\",\n \"other_functional_area\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"email": "jsmith@example.com",
"sent_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"accepted_at": "2023-11-07T05:31:56Z",
"revoked_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": 123,
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"picture": "<string>",
"role": "<string>",
"functional_area": "data_analytics",
"other_functional_area": "<string>",
"date_joined": "2023-11-07T05:31:56Z",
"last_login": "2023-11-07T05:31:56Z",
"is_active": false,
"is_pending": false,
"joined_at": "2023-11-07T05:31:56Z",
"workspace_is_active": true
},
"first_name": "<string>",
"last_name": "<string>",
"role": "member",
"functional_area": "data_analytics",
"other_functional_area": "<string>"
}Legacy endpoint.
/api/v1/invitations/ predates workspaces. It keeps working for existing integrations, but it cannot place an invitee in a workspace. New integrations should use Invite User, which takes the same request with the role named organization_role and accepts workspaces.email, role (owner, admin, or member; defaults to member), and the optional first_name, last_name, functional_area, and other_functional_area. It answers 201 for a new invitation and 200 for a resend, with the legacy invitation object. The rules, resend behavior, and errors are the same as Invite User.Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
data_analytics- Data & Analyticssales- Salescustomer_support- Customer Supportoperations- Operationsmarketing- Marketingfinance- Financeproduct_development- Product Developmentgrowth- Growthexecutive_leadership- Executive Leadershipother- Other
Available options:
data_analytics, sales, customer_support, operations, marketing, finance, product_development, growth, executive_leadership, other Response
201 - application/json
data_analytics- Data & Analyticssales- Salescustomer_support- Customer Supportoperations- Operationsmarketing- Marketingfinance- Financeproduct_development- Product Developmentgrowth- Growthexecutive_leadership- Executive Leadershipother- Other
Available options:
data_analytics, sales, customer_support, operations, marketing, finance, product_development, growth, executive_leadership, other Was this page helpful?