---
title: "Turn product emails or the newsletter on or off"
method: POST
path: "/me/email-preferences"
tags: ["Account"]
---

# Turn product emails or the newsletter on or off

`POST /me/email-preferences`

## Request

- Base URL: `https://adslighthouse.com/api/v1`
- URL: `https://adslighthouse.com/api/v1/me/email-preferences`
- Auth: HTTP bearer

Turns optional product emails and the newsletter on or off for the person the credential acts for, with the same services as Settings > Email preferences. newsletter true records an explicit newsletter subscription: only set it when that person asked to subscribe. Omitted fields keep their value. Requires the write scope.

## Request body

- object
  - `product_emails` boolean
  - `newsletter` boolean

## Response `200`

Turn product emails or the newsletter on or off

- object
  - `email` string, required: The address these preferences apply to.
  - `product_emails` boolean, required: Optional product emails: getting-started tips, the first-results notice and the 80% usage notice.
  - `newsletter` 'subscribed' | 'pending' | 'unsubscribed' | 'none', required: Newsletter status. pending waits for the confirmation email; none means never subscribed.
  - `request_id` string

## Other responses

- `400`: Invalid parameters, cursor or body.
- `401`: Missing, invalid, expired or revoked credential.
- `403`: The credential lacks the write scope, the plan does not include the API, or the allowance is used up.
- `404`: Unknown project, keyword or run in this account.
- `409`: The idempotency key was already used for a different request.
- `429`: Rate limit reached. Retry after the Retry-After seconds.
- `503`: The requested service or file is temporarily unavailable.

---

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