Subscribe contact to newsletter
curl --request GET \
--url https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter \
--header 'Api-Token: <api-key>'import requests
url = "https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter"
headers = {"Api-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Api-Token': '<api-key>'}};
fetch('https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter', 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/contact/{id}/subscribe-to-newsletter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-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"
"net/http"
"io"
)
func main() {
url := "https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter")
.header("Api-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 42,
"name": "Boston Chapter",
"middleName": "L.",
"email": "james.patterson@example.com",
"phone": "+1 415 555 0142",
"isEventAppPhonePrivate": true,
"isEventAppEmailPrivate": true,
"prefEventAppOnboardingSeen": true,
"isEventAppProfilePublic": true,
"organisation": "Civic Collective",
"role": "ROLE_USER",
"twitter": "https://twitter.com/jpatterson",
"linkedin": "https://linkedin.com/in/james-patterson",
"instagram": "https://instagram.com/jpatterson",
"bsky": "@jpatterson.bsky.social",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png",
"bio": "Volunteer organizer in the Boston chapter since 2022.",
"country": {
"id": 42,
"name": "Boston Chapter"
},
"isNewsletterSubscribed": true,
"stripeCustomerId": "cus_NhpBuxIyR4Qbpd",
"town": {
"id": 42,
"name": "Boston Chapter",
"country": {
"id": 42,
"name": "Boston Chapter"
}
},
"dateCreated": "2026-01-15T10:30:00+00:00",
"isValidatedIdentity": true,
"isValidatedIdentityPending": true,
"identity": {
"id": 42,
"isValidated": true,
"hasUploadedDocument": true,
"idAddress": "123 Beacon Street, Boston, MA 02108",
"status": "ACTIVE",
"addressStreet": "123 Beacon Street, Boston, MA 02108",
"addressDetails": "123 Beacon Street, Boston, MA 02108"
},
"isEmailConfirmed": true,
"localCenter": {
"id": 42,
"name": "Boston Chapter"
},
"product": "/api/v1/products/1",
"companyIdentifier": "US-123456789",
"companyName": "Civic Collective LLC",
"companyAddress": "123 Beacon Street, Boston, MA 02108",
"customFieldValues": [
{
"id": 42,
"field": {
"id": 42,
"name": "Boston Chapter",
"fieldType": "string"
},
"value": "Vegetarian",
"media": {
"id": 42,
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"mimeType": "application/pdf",
"originalName": "Boston Chapter"
},
"dateCreated": "2026-01-15T10:30:00+00:00"
}
],
"professionOrganisationRole": "Civic Collective",
"companyRegNo": "DE-HRB-12345",
"status": {
"id": 42,
"name": "Boston Chapter",
"color": "#16A34A",
"position": 42
},
"lastStatusUpdate": "2026-01-15T10:30:00+00:00",
"tags": [
{
"id": 42,
"tag": {
"id": 42,
"name": "Boston Chapter"
},
"createdAt": "2026-01-15T10:30:00+00:00"
}
],
"contactNotes": [
{
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"text": "Hello, you're invited to the Annual General Meeting.",
"action": "string",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateUpdated": "2026-01-15T10:30:00+00:00",
"authorName": "Boston Chapter",
"authorId": 42,
"authorLogo": "https://cdn.orgo.space/tenants/acme/logo.png"
}
],
"gender": "M",
"dateBirth": "2026-01-15T10:30:00+00:00",
"source": "string",
"fullName": "James Patterson",
"firstName": "James",
"lastName": "Patterson",
"age": 34,
"hasPersonalIdNumber": true
}Contact
Subscribe contact to newsletter
Sets the contact newsletter subscription flag to true. Creates an audit log entry recording the subscription. Requires HR_TENANT permission.
GET
/
api
/
v1
/
contact
/
{id}
/
subscribe-to-newsletter
Subscribe contact to newsletter
curl --request GET \
--url https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter \
--header 'Api-Token: <api-key>'import requests
url = "https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter"
headers = {"Api-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'Api-Token': '<api-key>'}};
fetch('https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter', 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/contact/{id}/subscribe-to-newsletter",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-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"
"net/http"
"io"
)
func main() {
url := "https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter")
.header("Api-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/contact/{id}/subscribe-to-newsletter")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 42,
"name": "Boston Chapter",
"middleName": "L.",
"email": "james.patterson@example.com",
"phone": "+1 415 555 0142",
"isEventAppPhonePrivate": true,
"isEventAppEmailPrivate": true,
"prefEventAppOnboardingSeen": true,
"isEventAppProfilePublic": true,
"organisation": "Civic Collective",
"role": "ROLE_USER",
"twitter": "https://twitter.com/jpatterson",
"linkedin": "https://linkedin.com/in/james-patterson",
"instagram": "https://instagram.com/jpatterson",
"bsky": "@jpatterson.bsky.social",
"logo": "https://cdn.orgo.space/tenants/acme/logo.png",
"bio": "Volunteer organizer in the Boston chapter since 2022.",
"country": {
"id": 42,
"name": "Boston Chapter"
},
"isNewsletterSubscribed": true,
"stripeCustomerId": "cus_NhpBuxIyR4Qbpd",
"town": {
"id": 42,
"name": "Boston Chapter",
"country": {
"id": 42,
"name": "Boston Chapter"
}
},
"dateCreated": "2026-01-15T10:30:00+00:00",
"isValidatedIdentity": true,
"isValidatedIdentityPending": true,
"identity": {
"id": 42,
"isValidated": true,
"hasUploadedDocument": true,
"idAddress": "123 Beacon Street, Boston, MA 02108",
"status": "ACTIVE",
"addressStreet": "123 Beacon Street, Boston, MA 02108",
"addressDetails": "123 Beacon Street, Boston, MA 02108"
},
"isEmailConfirmed": true,
"localCenter": {
"id": 42,
"name": "Boston Chapter"
},
"product": "/api/v1/products/1",
"companyIdentifier": "US-123456789",
"companyName": "Civic Collective LLC",
"companyAddress": "123 Beacon Street, Boston, MA 02108",
"customFieldValues": [
{
"id": 42,
"field": {
"id": 42,
"name": "Boston Chapter",
"fieldType": "string"
},
"value": "Vegetarian",
"media": {
"id": 42,
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"mimeType": "application/pdf",
"originalName": "Boston Chapter"
},
"dateCreated": "2026-01-15T10:30:00+00:00"
}
],
"professionOrganisationRole": "Civic Collective",
"companyRegNo": "DE-HRB-12345",
"status": {
"id": 42,
"name": "Boston Chapter",
"color": "#16A34A",
"position": 42
},
"lastStatusUpdate": "2026-01-15T10:30:00+00:00",
"tags": [
{
"id": 42,
"tag": {
"id": 42,
"name": "Boston Chapter"
},
"createdAt": "2026-01-15T10:30:00+00:00"
}
],
"contactNotes": [
{
"uuid": "01938d8e-9c4f-7c2a-b8e1-3f7a9b8c4f12",
"text": "Hello, you're invited to the Annual General Meeting.",
"action": "string",
"dateCreated": "2026-01-15T10:30:00+00:00",
"dateUpdated": "2026-01-15T10:30:00+00:00",
"authorName": "Boston Chapter",
"authorId": 42,
"authorLogo": "https://cdn.orgo.space/tenants/acme/logo.png"
}
],
"gender": "M",
"dateBirth": "2026-01-15T10:30:00+00:00",
"source": "string",
"fullName": "James Patterson",
"firstName": "James",
"lastName": "Patterson",
"age": 34,
"hasPersonalIdNumber": true
}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
Contact identifier
Response
Contact resource
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"/api/v1/products/1"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes

