---
search:
  tags:
    - Unsubscribes
    - POST
seo:
  description: >-
    Record an unsubscribe. Reference for the POST /unsubscribes endpoint in the
    BillionSend API.
sidebar:
  label: Record an unsubscribe
  badge: POST
title: Record an unsubscribe
type: openapi-operation
---
`POST /unsubscribes`

**Request body** (`application/json`, required)

- `email` (string<email>, required) — Bare email address that opted out; stored normalized (lowercase)
- `domain_id` (string<uuid> | null) — One of your domains: the address stops receiving marketing mail from it. Omitted or null: from every domain of the team

Request body example:

```json
{
  "email": "user@example.com",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c"
}
```

**Responses**

- `200` — The address now stops receiving marketing mail from the domain (domain\_id) or from every domain of the team (domain\_id omitted or null). Idempotent: an opt-out that already exists is returned as it is, with its original created\_at.
- `401` — Missing, malformed, unknown or revoked API key
- `403` — A key held to one domain recorded an opt-out for another domain or for the whole team
- `422` — Validation error, or a domain\_id that is not one of your domains
- `429` — Over the rate limit (rate\_limit\_exceeded, with Retry-After)

Response example, 200:

```json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "email": "string",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "domain": "string",
  "created_at": "string",
  "object": "unsubscribe"
}
```
