# Newsletter

> Newsletter sign-ups from the shop.

Newsletter sign-ups from the shop. Generated from the [OpenAPI spec](https://dev.mongrl.com/openapi.json). Each endpoint says which key it needs; see [Authentication](https://dev.mongrl.com/guides/authentication.md).

| Method | Path | What it does |
|---|---|---|
| POST | [`/v1/newsletter/subscribers`](#sign-up-for-the-newsletter) | Sign up for the newsletter |

## Sign up for the newsletter

`POST /v1/newsletter/subscribers` · operation `subscribeNewsletter`

Always answers 202 for a valid address, so it never reveals who's signed up; signing up again changes nothing. mongrl keeps the list and adds new addresses to the marketplace's Resend contacts. Call from the shop's server.

**Auth:** a secret or publishable key (`Authorization: Bearer sk_…` or `pk_…`)

**Body** (`application/json`): [SubscribeNewsletterRequest](#subscribenewsletterrequest)

**Responses:** `202` Accepted · `default` [a problem](https://dev.mongrl.com/reference/conventions.md#errors)

## Schemas

Fields marked * are always present in responses and required in requests.

### SubscribeNewsletterRequest

| Field | Type | Notes |
|---|---|---|
| `email` * | string (email) | max 254 chars |
| `first_name` | string | max 100 chars |
| `locale` | string | max 35 chars |
| `source` | string | Where they signed up, e.g. home or footer. max 60 chars |