Updates the Newsletter resource.
curl --request PATCH \
--url https://app.orgo.space/api/v1/newsletters/{uuid} \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/merge-patch+json' \
--data @- <<EOF
{
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": "/api/v1/users/1",
"html": "<p>Hello {{firstName}},</p><p>You're invited.</p>",
"design": [
"string"
],
"htmlRaw": "string",
"cssRaw": "string",
"htmlInline": "string",
"unit": "/api/v1/units/1",
"localCenter": "/api/v1/local_centers/1",
"isGeneral": true,
"isContacts": true,
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": "/api/v1/events/1",
"sendToEverybody": true,
"isPublic": true,
"userList": "/api/v1/user_lists/1",
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string"
}
EOFimport requests
url = "https://app.orgo.space/api/v1/newsletters/{uuid}"
payload = {
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": "/api/v1/users/1",
"html": "<p>Hello {{firstName}},</p><p>You're invited.</p>",
"design": ["string"],
"htmlRaw": "string",
"cssRaw": "string",
"htmlInline": "string",
"unit": "/api/v1/units/1",
"localCenter": "/api/v1/local_centers/1",
"isGeneral": True,
"isContacts": True,
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": "/api/v1/events/1",
"sendToEverybody": True,
"isPublic": True,
"userList": "/api/v1/user_lists/1",
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string"
}
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({
name: 'Boston Chapter',
subject: 'Welcome to Boston Chapter',
owner: '/api/v1/users/1',
html: '<p>Hello {{firstName}},</p><p>You\'re invited.</p>',
design: ['string'],
htmlRaw: 'string',
cssRaw: 'string',
htmlInline: 'string',
unit: '/api/v1/units/1',
localCenter: '/api/v1/local_centers/1',
isGeneral: true,
isContacts: true,
dateSent: '2026-01-15T10:30:00+00:00',
status: 'ACTIVE',
recipients: 42,
event: '/api/v1/events/1',
sendToEverybody: true,
isPublic: true,
userList: '/api/v1/user_lists/1',
scheduledAt: '2026-01-15T10:30:00+00:00',
timezone: 'America/New_York',
senderName: 'Boston Chapter',
replyTo: 'string'
})
};
fetch('https://app.orgo.space/api/v1/newsletters/{uuid}', 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/newsletters/{uuid}",
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([
'name' => 'Boston Chapter',
'subject' => 'Welcome to Boston Chapter',
'owner' => '/api/v1/users/1',
'html' => '<p>Hello {{firstName}},</p><p>You\'re invited.</p>',
'design' => [
'string'
],
'htmlRaw' => 'string',
'cssRaw' => 'string',
'htmlInline' => 'string',
'unit' => '/api/v1/units/1',
'localCenter' => '/api/v1/local_centers/1',
'isGeneral' => true,
'isContacts' => true,
'dateSent' => '2026-01-15T10:30:00+00:00',
'status' => 'ACTIVE',
'recipients' => 42,
'event' => '/api/v1/events/1',
'sendToEverybody' => true,
'isPublic' => true,
'userList' => '/api/v1/user_lists/1',
'scheduledAt' => '2026-01-15T10:30:00+00:00',
'timezone' => 'America/New_York',
'senderName' => 'Boston Chapter',
'replyTo' => 'string'
]),
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/newsletters/{uuid}"
payload := strings.NewReader("{\n \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\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/newsletters/{uuid}")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/newsletters/{uuid}")
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 \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": {
"id": 42,
"firstName": "James",
"lastName": "Patterson",
"fullName": "James Patterson"
},
"design": [
"string"
],
"htmlRaw": "string",
"clicks": [
"string"
],
"unit": {
"id": 42,
"name": "Boston Chapter"
},
"tenant": "/api/v1/tenants/1",
"localCenter": {
"id": 42,
"name": "Boston Chapter"
},
"isGeneral": true,
"isContacts": true,
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": {
"id": 42,
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"name": "Boston Chapter",
"meetExists": true,
"numberOfParticipants": 42,
"settings": [
"string"
]
},
"sendToEverybody": true,
"isPublic": true,
"slugGo": "agm26",
"publicPreviewLogo": "https://cdn.orgo.space/tenants/acme/logo.png",
"userList": {
"id": 42,
"name": "Boston Chapter"
},
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string",
"parentNewsletter": "/api/v1/newsletters/1"
}Newsletter
Updates the Newsletter resource.
Updates the Newsletter resource.
PATCH
/
api
/
v1
/
newsletters
/
{uuid}
Updates the Newsletter resource.
curl --request PATCH \
--url https://app.orgo.space/api/v1/newsletters/{uuid} \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/merge-patch+json' \
--data @- <<EOF
{
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": "/api/v1/users/1",
"html": "<p>Hello {{firstName}},</p><p>You're invited.</p>",
"design": [
"string"
],
"htmlRaw": "string",
"cssRaw": "string",
"htmlInline": "string",
"unit": "/api/v1/units/1",
"localCenter": "/api/v1/local_centers/1",
"isGeneral": true,
"isContacts": true,
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": "/api/v1/events/1",
"sendToEverybody": true,
"isPublic": true,
"userList": "/api/v1/user_lists/1",
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string"
}
EOFimport requests
url = "https://app.orgo.space/api/v1/newsletters/{uuid}"
payload = {
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": "/api/v1/users/1",
"html": "<p>Hello {{firstName}},</p><p>You're invited.</p>",
"design": ["string"],
"htmlRaw": "string",
"cssRaw": "string",
"htmlInline": "string",
"unit": "/api/v1/units/1",
"localCenter": "/api/v1/local_centers/1",
"isGeneral": True,
"isContacts": True,
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": "/api/v1/events/1",
"sendToEverybody": True,
"isPublic": True,
"userList": "/api/v1/user_lists/1",
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string"
}
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({
name: 'Boston Chapter',
subject: 'Welcome to Boston Chapter',
owner: '/api/v1/users/1',
html: '<p>Hello {{firstName}},</p><p>You\'re invited.</p>',
design: ['string'],
htmlRaw: 'string',
cssRaw: 'string',
htmlInline: 'string',
unit: '/api/v1/units/1',
localCenter: '/api/v1/local_centers/1',
isGeneral: true,
isContacts: true,
dateSent: '2026-01-15T10:30:00+00:00',
status: 'ACTIVE',
recipients: 42,
event: '/api/v1/events/1',
sendToEverybody: true,
isPublic: true,
userList: '/api/v1/user_lists/1',
scheduledAt: '2026-01-15T10:30:00+00:00',
timezone: 'America/New_York',
senderName: 'Boston Chapter',
replyTo: 'string'
})
};
fetch('https://app.orgo.space/api/v1/newsletters/{uuid}', 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/newsletters/{uuid}",
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([
'name' => 'Boston Chapter',
'subject' => 'Welcome to Boston Chapter',
'owner' => '/api/v1/users/1',
'html' => '<p>Hello {{firstName}},</p><p>You\'re invited.</p>',
'design' => [
'string'
],
'htmlRaw' => 'string',
'cssRaw' => 'string',
'htmlInline' => 'string',
'unit' => '/api/v1/units/1',
'localCenter' => '/api/v1/local_centers/1',
'isGeneral' => true,
'isContacts' => true,
'dateSent' => '2026-01-15T10:30:00+00:00',
'status' => 'ACTIVE',
'recipients' => 42,
'event' => '/api/v1/events/1',
'sendToEverybody' => true,
'isPublic' => true,
'userList' => '/api/v1/user_lists/1',
'scheduledAt' => '2026-01-15T10:30:00+00:00',
'timezone' => 'America/New_York',
'senderName' => 'Boston Chapter',
'replyTo' => 'string'
]),
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/newsletters/{uuid}"
payload := strings.NewReader("{\n \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\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/newsletters/{uuid}")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/merge-patch+json")
.body("{\n \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/newsletters/{uuid}")
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 \"name\": \"Boston Chapter\",\n \"subject\": \"Welcome to Boston Chapter\",\n \"owner\": \"/api/v1/users/1\",\n \"html\": \"<p>Hello {{firstName}},</p><p>You're invited.</p>\",\n \"design\": [\n \"string\"\n ],\n \"htmlRaw\": \"string\",\n \"cssRaw\": \"string\",\n \"htmlInline\": \"string\",\n \"unit\": \"/api/v1/units/1\",\n \"localCenter\": \"/api/v1/local_centers/1\",\n \"isGeneral\": true,\n \"isContacts\": true,\n \"dateSent\": \"2026-01-15T10:30:00+00:00\",\n \"status\": \"ACTIVE\",\n \"recipients\": 42,\n \"event\": \"/api/v1/events/1\",\n \"sendToEverybody\": true,\n \"isPublic\": true,\n \"userList\": \"/api/v1/user_lists/1\",\n \"scheduledAt\": \"2026-01-15T10:30:00+00:00\",\n \"timezone\": \"America/New_York\",\n \"senderName\": \"Boston Chapter\",\n \"replyTo\": \"string\"\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"name": "Boston Chapter",
"subject": "Welcome to Boston Chapter",
"owner": {
"id": 42,
"firstName": "James",
"lastName": "Patterson",
"fullName": "James Patterson"
},
"design": [
"string"
],
"htmlRaw": "string",
"clicks": [
"string"
],
"unit": {
"id": 42,
"name": "Boston Chapter"
},
"tenant": "/api/v1/tenants/1",
"localCenter": {
"id": 42,
"name": "Boston Chapter"
},
"isGeneral": true,
"isContacts": true,
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateSent": "2026-01-15T10:30:00+00:00",
"status": "ACTIVE",
"recipients": 42,
"event": {
"id": 42,
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"name": "Boston Chapter",
"meetExists": true,
"numberOfParticipants": 42,
"settings": [
"string"
]
},
"sendToEverybody": true,
"isPublic": true,
"slugGo": "agm26",
"publicPreviewLogo": "https://cdn.orgo.space/tenants/acme/logo.png",
"userList": {
"id": 42,
"name": "Boston Chapter"
},
"scheduledAt": "2026-01-15T10:30:00+00:00",
"timezone": "America/New_York",
"senderName": "Boston Chapter",
"replyTo": "string",
"parentNewsletter": "/api/v1/newsletters/1"
}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
Newsletter identifier
Body
application/merge-patch+json
The updated Newsletter resource
Example:
"/api/v1/users/1"
Example:
"/api/v1/units/1"
Example:
"/api/v1/local_centers/1"
Example:
"/api/v1/events/1"
Example:
"/api/v1/user_lists/1"
Response
Newsletter resource updated
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"/api/v1/tenants/1"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I

