---
title: "A recipient unsubscribed"
method: POST
path: "unsubscribed"
tags: ["Message events"]
---

# A recipient unsubscribed

`POST unsubscribed` (webhook)

The recipient unsubscribed through the link or their mail client's one-click button; only Sendora support lifts that suppression.

## Headers

- `Sendora-Signature` string, required
- `Sendora-Event` string, required
- `Sendora-Delivery-Id` string, required
- `User-Agent` string, required

## Payload

- object: The recipient unsubscribed through the link or their mail client's one-click button; only Sendora support lifts that suppression.
  - `id` string, required: The delivery's id. A delivery may arrive more than once, so key your handling on it.
  - `attempt` integer, required: The attempt number, from 1.
  - `messageId` string, required: The message the event is about.
  - `recipient` string, required: The recipient the event is about.
  - `occurredAt` string, date-time, required: When it happened.
  - `serverId` string, required: The server the message was sent from.
  - `streamId` string, required: The stream the message went on.
  - `broadcastId` string, nullable, required: The broadcast the message belongs to; null for a message sent on its own.
  - `tag` string, nullable, required: The tag you sent with the message.
  - `metadata` object, required: The metadata you sent with the message.
  - `test` boolean, required: True for a test server's message: the event was simulated and nothing was sent.
  - `event` 'unsubscribed', required
  - `details` object, required
    - `source` 'link' | 'one_click', required: `link` for the page's button, `one_click` for a mail client's request.

## Acknowledgement `2XX`

Acknowledges the delivery. Any other answer, or none within 10 seconds, is retried.

---

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