---
title: "Surface unsubscribe methods for a message."
method: GET
path: "/v1/messages/{id}/unsubscribe"
tags: ["Messages"]
---

# Surface unsubscribe methods for a message.

`GET /v1/messages/{id}/unsubscribe`

## Request

- Base URL: `https://api.inboxy.net`
- URL: `https://api.inboxy.net/v1/messages/{id}/unsubscribe`
- Auth: HTTP bearer

Parses the `List-Unsubscribe` header (RFC 2369 — mailto + URLs), the `List-Unsubscribe-Post: List-Unsubscribe=One-Click` flag (RFC 8058), and body `<a>` links whose anchor text or URL path matches `/unsubscribe|opt-out/i`. **Read-only** — the server does NOT visit or POST the URL. The caller decides what to do with `recommended` (one_click_post is the only auto-safe option; mailto goes through the user's normal sender path; generic http links must be opened by hand).

## Path parameters

- `id` string, uuid, required

## Response `200`

Parsed unsubscribe info.

- UnsubscribeInfo: Unsubscribe methods parsed from a message. `recommended` is the first by preference: one_click_post (RFC 8058) → mailto → http link.
  - `id` string, uuid, required
  - `from` string, nullable, required
  - `subject` string, nullable, required
  - `methods` UnsubMethod[], required
    - union
      - object
        - `kind` 'one_click_post', required
        - `url` string, uri, required
        - `source` 'header', required
      - object
        - `kind` 'http', required
        - `url` string, uri, required
        - `source` 'header' | 'body', required
        - `text` string, nullable
      - object
        - `kind` 'mailto', required
        - `url` string, required
        - `to` string, email, required
        - `subject` string, nullable, required
        - `source` 'header', required
  - `recommended` union, required
    - object
      - `kind` 'one_click_post', required
      - `url` string, uri, required
      - `source` 'header', required
    - object
      - `kind` 'http', required
      - `url` string, uri, required
      - `source` 'header' | 'body', required
      - `text` string, nullable
    - object
      - `kind` 'mailto', required
      - `url` string, required
      - `to` string, email, required
      - `subject` string, nullable, required
      - `source` 'header', required

## Other responses

- `404`: No matching resource owned by the caller.
- `410`: Body lost, purged, or unparseable.

---

[API](https://skmtc.dev/inboxy/apis/inboxy-api.md) · [All operations](https://skmtc.dev/inboxy/apis/inboxy-api/llms.txt) · [OpenAPI document](https://skmtc.dev/inboxy/apis/inboxy-api/revisions/25155a8dec0f?raw)