> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbit.devotel.io/llms.txt
> Use this file to discover all available pages before exploring further.
# 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.
## OpenAPI
````yaml /openapi.yaml get /api/v1/email/unsubscribe/{token}
openapi: 3.1.0
info:
title: Devotel CPaaS API
description: Orbit by Devotel — Communications Platform as a Service API
version: 1.0.0
contact:
name: Devotel
url: https://devotel.io
email: support@devotel.io
license:
name: Proprietary
servers:
- url: https://api.orbit.devotel.io
description: Production
security:
- Bearer: []
- ApiKey: []
tags:
- name: Messages
description: >-
Send and manage messages across all channels (SMS, WhatsApp, RCS, Email,
Viber, etc.)
- name: Fax
description: >-
List and track fax (MMS/T.38) transmissions on Telnyx-backed fax numbers
(sending flows through the Messaging API)
- name: Agents
description: AI agent creation, configuration, and execution
- name: Voice
description: Voice calls, IVR, conferencing, and SIP trunking
- name: OnCall
description: On-call rotations and escalation policy planning for incident alerting
- name: Webhooks
description: Webhook endpoint management and delivery logs
- name: Numbers
description: Phone number search, provisioning, and configuration
- name: Brand Identity
description: >-
Unified cross-channel brand trust posture (10DLC, toll-free, WhatsApp,
RCS, branded calling, number KYC)
- name: Contacts
description: Contact management, segmentation, and lifecycle tracking
- name: Campaigns
description: Marketing campaign orchestration and analytics
- name: Flows
description: Automation flow builder and execution engine
- name: Templates
description: Message template management and approval workflows
- name: Settings
description: Organization, channel, and user preference settings
- name: Verify
description: OTP generation and verification across channels
- name: Push
description: Push notification delivery via FCM and APNs
- name: Integrations
description: Third-party service connections and OAuth management
- name: CDP
description: >-
Customer Data Platform — activation surface (CRM object sync, streaming
destinations, ad-audience activation)
- name: Files
description: >-
Server-to-server media upload, listing, retrieval, and deletion
(signed-URL backed)
- name: Commerce
description: >-
Omnichannel conversational-commerce — persistent cart + checkout state
machine, channel-agnostic hosted pay-by-link, native WhatsApp checkout,
and AP2-style agent payment mandates.
- name: Sync
description: >-
Real-time shared-state primitive (Twilio Sync parity) — Documents, Maps,
Lists, and ephemeral Streams, with change events relayed over the
/api/v1/ws/sync WebSocket gateway
- name: Risk
description: >-
Unified cross-channel Trust & Fraud risk scoring — fuses SMS-pumping,
URL-reputation, Verify Fraud Guard, and Voice Biometrics signals into one
composite verdict queryable before a send or a call.
- name: Orby
description: >-
In-dashboard Orby operator assistant: streamed assistant turns,
conversation threads, product knowledge-base search, and the tool-action
approval gate. Available to signed-in operators only (dashboard session
auth — API-key requests are rejected).
paths:
/api/v1/email/unsubscribe/{token}:
get:
tags:
- Email
summary: Process a one-click email unsubscribe
description: >-
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.
parameters:
- schema:
type: string
in: path
name: token
required: true
description: >-
Signed, single-use unsubscribe token minted by Orbit and embedded in
the email's `List-Unsubscribe` header/link. Opaque to callers.
responses:
'200':
description: >-
The recipient was suppressed and no sender redirect is configured,
so a minimal HTML confirmation page is returned.
content:
text/html:
schema:
type: string
example: >-
UnsubscribedYou
are unsubscribed
jordan@example.com will
no longer receive these emails.
'302':
description: >-
The recipient was suppressed and the sender has a configured
unsubscribe redirect; the response redirects there with `email` and
`opt_out_id` query parameters appended.
'400':
description: >-
The token is missing, malformed, expired, or failed signature
verification. An HTML error page is returned and no suppression is
recorded.
content:
text/html:
schema:
type: string
components:
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: Dashboard JWT token from Clerk
ApiKey:
type: apiKey
name: X-API-Key
in: header
description: Server-to-server API key (dv_live_sk_*)
````