> ## 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.

# Confirm a one-click email unsubscribe

> RFC 8058 one-click `POST` counterpart of the unsubscribe link. Mail clients that honour `List-Unsubscribe-Post` send an `application/x-www-form-urlencoded` body of `List-Unsubscribe=One-Click` to this URL to unsubscribe the recipient without a browser round-trip. The signed `{token}` is the only credential; the suppression effect is identical to the `GET` form and is idempotent.



## OpenAPI

````yaml /openapi.yaml post /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}:
    post:
      tags:
        - Email
      summary: Confirm a one-click email unsubscribe
      description: >-
        RFC 8058 one-click `POST` counterpart of the unsubscribe link. Mail
        clients that honour `List-Unsubscribe-Post` send an
        `application/x-www-form-urlencoded` body of `List-Unsubscribe=One-Click`
        to this URL to unsubscribe the recipient without a browser round-trip.
        The signed `{token}` is the only credential; the suppression effect is
        identical to the `GET` form and is idempotent.
      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. Opaque to callers.
      requestBody:
        required: false
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                List-Unsubscribe:
                  type: string
                  enum:
                    - One-Click
                  description: >-
                    RFC 8058 one-click marker. Mail clients send exactly
                    `List-Unsubscribe=One-Click`.
            example:
              List-Unsubscribe: One-Click
      responses:
        '200':
          description: >-
            The recipient was suppressed and no sender redirect is configured; a
            minimal HTML confirmation page is returned.
          content:
            text/html:
              schema:
                type: string
        '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_*)

````