Email an invite link to a recipient
curl --request POST \
--url https://pria.praxislxp.com/api/user/institutionSendInvite \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institutionId": "60d5ec49f1b2c72b9c8e4d3a",
"email": "newuser@example.com"
}
'import requests
url = "https://pria.praxislxp.com/api/user/institutionSendInvite"
payload = {
"institutionId": "60d5ec49f1b2c72b9c8e4d3a",
"email": "newuser@example.com"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({institutionId: '60d5ec49f1b2c72b9c8e4d3a', email: 'newuser@example.com'})
};
fetch('https://pria.praxislxp.com/api/user/institutionSendInvite', 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://pria.praxislxp.com/api/user/institutionSendInvite",
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([
'institutionId' => '60d5ec49f1b2c72b9c8e4d3a',
'email' => 'newuser@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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://pria.praxislxp.com/api/user/institutionSendInvite"
payload := strings.NewReader("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<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://pria.praxislxp.com/api/user/institutionSendInvite")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/institutionSendInvite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invitation sent"
}{
"success": false,
"message": "Invalid email address"
}{
"success": false,
"message": "Authentication Required"
}{
"success": false,
"message": "Unauthorized for users"
}{
"success": false,
"message": "Not Found"
}Membership
Email an invite link to a recipient
Composes an invitation email containing the institution’s join link and sends it to the supplied email address. Requires admin or super privileges. Reuses the institution’s existing joinId or generates one on demand.
POST
/
api
/
user
/
institutionSendInvite
Email an invite link to a recipient
curl --request POST \
--url https://pria.praxislxp.com/api/user/institutionSendInvite \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"institutionId": "60d5ec49f1b2c72b9c8e4d3a",
"email": "newuser@example.com"
}
'import requests
url = "https://pria.praxislxp.com/api/user/institutionSendInvite"
payload = {
"institutionId": "60d5ec49f1b2c72b9c8e4d3a",
"email": "newuser@example.com"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({institutionId: '60d5ec49f1b2c72b9c8e4d3a', email: 'newuser@example.com'})
};
fetch('https://pria.praxislxp.com/api/user/institutionSendInvite', 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://pria.praxislxp.com/api/user/institutionSendInvite",
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([
'institutionId' => '60d5ec49f1b2c72b9c8e4d3a',
'email' => 'newuser@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-token: <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://pria.praxislxp.com/api/user/institutionSendInvite"
payload := strings.NewReader("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-access-token", "<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://pria.praxislxp.com/api/user/institutionSendInvite")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/institutionSendInvite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"institutionId\": \"60d5ec49f1b2c72b9c8e4d3a\",\n \"email\": \"newuser@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Invitation sent"
}{
"success": false,
"message": "Invalid email address"
}{
"success": false,
"message": "Authentication Required"
}{
"success": false,
"message": "Unauthorized for users"
}{
"success": false,
"message": "Not Found"
}Authorizations
JWT token passed in x-access-token header
Body
application/json
Was this page helpful?
⌘I