curl --request POST \
--url https://api.qumo-deploy.com/v1/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"role_id": "roles/organization.admin"
}
'import requests
url = "https://api.qumo-deploy.com/v1/invitations"
payload = {
"email": "[email protected]",
"role_id": "roles/organization.admin"
}
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: '[email protected]', role_id: 'roles/organization.admin'})
};
fetch('https://api.qumo-deploy.com/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.qumo-deploy.com/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' => '[email protected]',
'role_id' => 'roles/organization.admin'
]),
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.qumo-deploy.com/v1/invitations"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\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.qumo-deploy.com/v1/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qumo-deploy.com/v1/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\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\n}"
response = http.request(request)
puts response.read_body{
"invitation": {
"id": "6b8d0f2a-4c6e-4a1b-9d3f-5e7a9c1b3d5f",
"organization_id": "3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c",
"email": "[email protected]",
"role_id": "roles/organization.admin",
"expires_at": "2026-11-10T08:00:00Z",
"created_at": "2026-11-03T08:00:00Z"
},
"invite_link": "https://console.qumo-deploy.com/join?token=8c1e3a5f7b9d2c4e6a8f0b1d3e5a7c9f2b4d6e8a0c1e3f5a7b9d1c3e5f7a9b2d"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}Invite someone to the organization
Emails an invitation to join the organization with the given role, and returns the invite link. The link expires after 7 days. You can invite only with roles whose permissions you hold yourself.
curl --request POST \
--url https://api.qumo-deploy.com/v1/invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"role_id": "roles/organization.admin"
}
'import requests
url = "https://api.qumo-deploy.com/v1/invitations"
payload = {
"email": "[email protected]",
"role_id": "roles/organization.admin"
}
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: '[email protected]', role_id: 'roles/organization.admin'})
};
fetch('https://api.qumo-deploy.com/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.qumo-deploy.com/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' => '[email protected]',
'role_id' => 'roles/organization.admin'
]),
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.qumo-deploy.com/v1/invitations"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\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.qumo-deploy.com/v1/invitations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.qumo-deploy.com/v1/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\": \"[email protected]\",\n \"role_id\": \"roles/organization.admin\"\n}"
response = http.request(request)
puts response.read_body{
"invitation": {
"id": "6b8d0f2a-4c6e-4a1b-9d3f-5e7a9c1b3d5f",
"organization_id": "3f8c2a1e-7b4d-4e9a-9c61-2d5e8f0a1b7c",
"email": "[email protected]",
"role_id": "roles/organization.admin",
"expires_at": "2026-11-10T08:00:00Z",
"created_at": "2026-11-03T08:00:00Z"
},
"invite_link": "https://console.qumo-deploy.com/join?token=8c1e3a5f7b9d2c4e6a8f0b1d3e5a7c9f2b4d6e8a0c1e3f5a7b9d1c3e5f7a9b2d"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}{
"error": "organization_id is required"
}Authorizations
A personal access token (POST /v1/auth/tokens) or a machine
identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens),
both prefixed qumo_pat_. A token's scopes cap what it can do; see
Scopes and permissions. A personal
token names no organization: on a route whose path names no project or
organization, pass ?organization_id=.
Query Parameters
The organization the request acts in. Required with a personal token or a session, which name no organization themselves; an identity token's organization is implied.
Body
The role the invitee gets on accepting. roles/platform.admin cannot be granted.
roles/project.viewer, roles/project.editor, roles/project.admin, roles/organization.admin "roles/organization.admin"
Response
The invitation and its link.