---
title: "Update a recipient tracking preference"
method: PATCH
path: "/v1/email/tracking/recipients"
tags: ["Email"]
---

# Update a recipient tracking preference

`PATCH /v1/email/tracking/recipients`

## Request

- Base URL: `https://api.samva.dev`
- URL: `https://api.samva.dev/v1/email/tracking/recipients`
- Auth: API key in header `x-api-key`

Opts a normalized recipient email in or out of open and click tracking. Opt-out takes precedence over per-send overrides and organization defaults without changing suppression or send eligibility.

## Request body

- object
  - `email` string, required
  - `optedOut` boolean, required

## Response `200`

EmailRecipientTrackingPreference

- EmailRecipientTrackingPreference
  - `email` string, required
  - `optedOut` boolean, required
  - `trackingOptedOutAt` string, nullable, required
  - `createdAt` string, nullable, required
  - `updatedAt` string, nullable, required

## Other responses

- `401`: UnauthorizedError
- `403`: ForbiddenError
- `422`: ValidationError
- `500`: InternalError
- `504`: GatewayTimeoutError

---

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