Process a one-click email unsubscribe

curl --request GET \
  --url https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}', 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.orbit.devotel.io/api/v1/email/unsubscribe/{token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<!doctype html><html lang=\"en\"><head><meta charset=\"utf-8\"><title>Unsubscribed</title></head><body><h1>You are unsubscribed</h1><p><strong>jordan@example.com</strong> will no longer receive these emails.</p></body></html>"

"<string>"

Process a one-click email unsubscribe

Public landing endpoint for the signed List-Unsubscribe URL that Orbit stamps into every outbound email. The {token} is an HMAC-signed value binding the tenant, message, and recipient — no API key or session is required, the token is the credential. Opening the link suppresses that recipient from future sends (idempotently) and either renders a confirmation page or 302-redirects to the sender’s configured unsubscribe page. Use this for the human-clickable (GET) half of RFC 8058 one-click unsubscribe.

GET

api

unsubscribe

{token}

Process a one-click email unsubscribe

curl --request GET \
  --url https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}', 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.orbit.devotel.io/api/v1/email/unsubscribe/{token}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orbit.devotel.io/api/v1/email/unsubscribe/{token}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<!doctype html><html lang=\"en\"><head><meta charset=\"utf-8\"><title>Unsubscribed</title></head><body><h1>You are unsubscribed</h1><p><strong>jordan@example.com</strong> will no longer receive these emails.</p></body></html>"

"<string>"

Authorizations

Authorization

string

header

required

Dashboard JWT token from Clerk

Path Parameters

token

string

required

Signed, single-use unsubscribe token minted by Orbit and embedded in the email's List-Unsubscribe header/link. Opaque to callers.

Response

The recipient was suppressed and no sender redirect is configured, so a minimal HTML confirmation page is returned.

The response is of type string.

API Reference

All Endpoints

Process a one-click email unsubscribe

Authorizations

Path Parameters

Response