---
title: "Unsubscribe"
method: POST
path: "/api/v1/unsubscribe"
tags: ["unsubscribe"]
---

# Unsubscribe

`POST /api/v1/unsubscribe`

## Request

- Base URL: `https://api.nudgelink.co` (the document declares no server; this is the origin it was published from)
- URL: `https://api.nudgelink.co/api/v1/unsubscribe`
- Auth: none declared

One-click unsubscribe. Sets ``Lead.email_opt_out=True`` on this lead
and on every lead of the same client with the same address, records the
address on the client's suppression list (so it survives deletion and the
90-day purge), and stops the open (active or paused) sequences of this
lead, of those same-address rows and of the same person's other rows by
LinkedIn profile (``_linkedin_twin_ids``). Renders a confirmation page.

We don't require any authentication — CAN-SPAM requires opt-out be
processable in 10 days, and one-click is the Gmail/Outlook 2024
bulk-sender requirement. A valid but expired link still works. The
page speaks the lead's language (``_lead_language``), else the browser's.

## Query parameters

- `token` string, required

## Headers

- `accept-language` string, nullable

## Response `200`

Successful Response

## Other responses

- `422`: Validation Error

---

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