Invite Project Members
curl --request POST \
--url https://api.peec.ai/customer/v1/members/invite \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"members": [
{
"email": "jane.doe@example.com",
"role": "VIEWER"
}
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/members/invite"
payload = {
"members": [
{
"email": "jane.doe@example.com",
"role": "VIEWER"
}
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({
members: [{email: 'jane.doe@example.com', role: 'VIEWER'}],
project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
})
};
fetch('https://api.peec.ai/customer/v1/members/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.peec.ai/customer/v1/members/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([
'members' => [
[
'email' => 'jane.doe@example.com',
'role' => 'VIEWER'
]
],
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/members/invite"
payload := strings.NewReader("{\n \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/members/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/members/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 \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"invited": [
{
"index": 123,
"email": "<string>",
"role": "VIEWER",
"access": "granted"
}
],
"skipped": [
{
"index": 123,
"email": "<string>",
"reason": "already_member"
}
],
"rejected": [
{
"index": 123,
"email": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>"
}Project
Invite Project Members
Invite people to the project by email, as a viewer or an owner. Each person gets the same invitation email as an invite from the app. An email that already has a Peec account gets access right away; anyone else gets access once they sign up from the email. An email that already has access or an open invitation lands in skipped, and the request never fails as a whole because of one item. Returns 403 when the company has turned off email invitations.
POST
/
members
/
invite
Invite Project Members
curl --request POST \
--url https://api.peec.ai/customer/v1/members/invite \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"members": [
{
"email": "jane.doe@example.com",
"role": "VIEWER"
}
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
'import requests
url = "https://api.peec.ai/customer/v1/members/invite"
payload = {
"members": [
{
"email": "jane.doe@example.com",
"role": "VIEWER"
}
],
"project_id": "or_f45b94ba-5e35-4982-93ed-285e72ee14eb"
}
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({
members: [{email: 'jane.doe@example.com', role: 'VIEWER'}],
project_id: 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
})
};
fetch('https://api.peec.ai/customer/v1/members/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.peec.ai/customer/v1/members/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([
'members' => [
[
'email' => 'jane.doe@example.com',
'role' => 'VIEWER'
]
],
'project_id' => 'or_f45b94ba-5e35-4982-93ed-285e72ee14eb'
]),
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.peec.ai/customer/v1/members/invite"
payload := strings.NewReader("{\n \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\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.peec.ai/customer/v1/members/invite")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.peec.ai/customer/v1/members/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 \"members\": [\n {\n \"email\": \"jane.doe@example.com\",\n \"role\": \"VIEWER\"\n }\n ],\n \"project_id\": \"or_f45b94ba-5e35-4982-93ed-285e72ee14eb\"\n}"
response = http.request(request)
puts response.read_body{
"invited": [
{
"index": 123,
"email": "<string>",
"role": "VIEWER",
"access": "granted"
}
],
"skipped": [
{
"index": 123,
"email": "<string>",
"reason": "already_member"
}
],
"rejected": [
{
"index": 123,
"email": "<string>",
"message": "<string>"
}
]
}{
"message": "<string>"
}Authorizations
APIKeyHeaderAPIKeyQueryBearerAuth
Body
application/jsonapplication/x-www-form-urlencodedmultipart/form-data
