Update a user list
curl --request PATCH \
--url https://app.orgo.space/api/v1/user_lists/{id} \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/merge-patch+json' \
--data '
{
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"owner": "/api/v1/users/1",
"criteria": [
"string"
],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}
'import requests
url = "https://app.orgo.space/api/v1/user_lists/{id}"
payload = {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"owner": "/api/v1/users/1",
"criteria": ["string"],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
tenant: '/api/v1/tenants/1',
name: 'Boston Chapter',
owner: '/api/v1/users/1',
criteria: ['string'],
type: 'static',
scope: 'members_and_contacts',
memberStatus: 'ALL',
descriptionPrompt: 'Quarterly chapter meeting open to all members.'
})
};
fetch('https://app.orgo.space/api/v1/user_lists/{id}', 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://app.orgo.space/api/v1/user_lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tenant' => '/api/v1/tenants/1',
'name' => 'Boston Chapter',
'owner' => '/api/v1/users/1',
'criteria' => [
'string'
],
'type' => 'static',
'scope' => 'members_and_contacts',
'memberStatus' => 'ALL',
'descriptionPrompt' => 'Quarterly chapter meeting open to all members.'
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"Content-Type: application/merge-patch+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://app.orgo.space/api/v1/user_lists/{id}"
payload := strings.NewReader("{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Api-Token", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.orgo.space/api/v1/user_lists/{id}")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/user_lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"createdAt": "2026-01-15T10:30:00+00:00",
"owner": {
"id": 42,
"fullName": "James Patterson",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png"
},
"criteria": [
"string"
],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}UserList
Update a user list
Updates user list properties such as name, criteria, and scope. Requires HR_TENANT or COMMUNICATION_TENANT permission.
PATCH
/
api
/
v1
/
user_lists
/
{id}
Update a user list
curl --request PATCH \
--url https://app.orgo.space/api/v1/user_lists/{id} \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/merge-patch+json' \
--data '
{
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"owner": "/api/v1/users/1",
"criteria": [
"string"
],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}
'import requests
url = "https://app.orgo.space/api/v1/user_lists/{id}"
payload = {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"owner": "/api/v1/users/1",
"criteria": ["string"],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/merge-patch+json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/merge-patch+json'},
body: JSON.stringify({
tenant: '/api/v1/tenants/1',
name: 'Boston Chapter',
owner: '/api/v1/users/1',
criteria: ['string'],
type: 'static',
scope: 'members_and_contacts',
memberStatus: 'ALL',
descriptionPrompt: 'Quarterly chapter meeting open to all members.'
})
};
fetch('https://app.orgo.space/api/v1/user_lists/{id}', 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://app.orgo.space/api/v1/user_lists/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'tenant' => '/api/v1/tenants/1',
'name' => 'Boston Chapter',
'owner' => '/api/v1/users/1',
'criteria' => [
'string'
],
'type' => 'static',
'scope' => 'members_and_contacts',
'memberStatus' => 'ALL',
'descriptionPrompt' => 'Quarterly chapter meeting open to all members.'
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"Content-Type: application/merge-patch+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://app.orgo.space/api/v1/user_lists/{id}"
payload := strings.NewReader("{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Api-Token", "<api-key>")
req.Header.Add("Content-Type", "application/merge-patch+json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.orgo.space/api/v1/user_lists/{id}")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/user_lists/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/merge-patch+json'
request.body = "{\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"criteria\": [\n \"string\"\n ],\n \"type\": \"static\",\n \"scope\": \"members_and_contacts\",\n \"memberStatus\": \"ALL\",\n \"descriptionPrompt\": \"Quarterly chapter meeting open to all members.\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"createdAt": "2026-01-15T10:30:00+00:00",
"owner": {
"id": 42,
"fullName": "James Patterson",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png"
},
"criteria": [
"string"
],
"type": "static",
"scope": "members_and_contacts",
"memberStatus": "ALL",
"descriptionPrompt": "Quarterly chapter meeting open to all members."
}Authorizations
ApiTokenJWT
Server-to-server authentication. Generate a token in the admin UI at
Settings → Developers → API Access. Send the raw token in the
Api-Token header — there is no Bearer prefix.
Tokens can be marked read-only at creation time, in which case the API
rejects any non-GET request with 403 Forbidden.
Path Parameters
UserList identifier
Body
application/merge-patch+json
The updated UserList resource
Example:
"/api/v1/tenants/1"
Example:
"/api/v1/users/1"
Available options:
static, dynamic Available options:
members_and_contacts, members_only, contacts_only Available options:
ALL, ACTIVE, INACTIVE Maximum string length:
1000Response
UserList resource updated
Available options:
static, dynamic Example:
"/api/v1/tenants/1"
Show child attributes
Show child attributes
Available options:
members_and_contacts, members_only, contacts_only Available options:
ALL, ACTIVE, INACTIVE Maximum string length:
1000⌘I

