curl --request POST \
--url https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "colleague@example.com",
"name": "Jane Doe",
"role": "Member"
}
'import requests
url = "https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations"
payload = {
"email": "colleague@example.com",
"name": "Jane Doe",
"role": "Member"
}
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: 'colleague@example.com', name: 'Jane Doe', role: 'Member'})
};
fetch('https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/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.sandbox.nevermined.app/api/v1/organizations/{orgId}/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' => 'colleague@example.com',
'name' => 'Jane Doe',
'role' => 'Member'
]),
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 := "https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations"
payload := strings.NewReader("{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\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("https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\n}"
response = http.request(request)
puts response.read_body{
"id": "oi-550e8400-e29b-41d4-a716-446655440000",
"email": "colleague@example.com",
"role": "Admin",
"status": "pending",
"expiresAt": "2023-11-07T05:31:56Z",
"invitedByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "Jane Doe"
}Invite a teammate by email
Creates a pending invitation for the given email and sends a magic-link email so the invitee can join the organization. The response is { success, invitation }; outside production it also includes magicLinkUrl for testing (it is omitted in production, where the link is delivered by email only). Requires a Nevermined API key. Requires organization admin privileges. Requires the organization to be on the Premium tier or higher.
curl --request POST \
--url https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "colleague@example.com",
"name": "Jane Doe",
"role": "Member"
}
'import requests
url = "https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations"
payload = {
"email": "colleague@example.com",
"name": "Jane Doe",
"role": "Member"
}
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: 'colleague@example.com', name: 'Jane Doe', role: 'Member'})
};
fetch('https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/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.sandbox.nevermined.app/api/v1/organizations/{orgId}/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' => 'colleague@example.com',
'name' => 'Jane Doe',
'role' => 'Member'
]),
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 := "https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations"
payload := strings.NewReader("{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\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("https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.nevermined.app/api/v1/organizations/{orgId}/invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"colleague@example.com\",\n \"name\": \"Jane Doe\",\n \"role\": \"Member\"\n}"
response = http.request(request)
puts response.read_body{
"id": "oi-550e8400-e29b-41d4-a716-446655440000",
"email": "colleague@example.com",
"role": "Admin",
"status": "pending",
"expiresAt": "2023-11-07T05:31:56Z",
"invitedByUserId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"name": "Jane Doe"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Organization ID
"org-abc123"
Body
Email address of the person to invite
254"colleague@example.com"
Display name of the invitee. Used to greet them in the email.
120"Jane Doe"
Role to assign in the organization
Admin, Member "Member"
Response
Invitation created
"oi-550e8400-e29b-41d4-a716-446655440000"
"colleague@example.com"
Admin, Member pending, accepted, revoked, expired "Jane Doe"
Was this page helpful?