Newsletter sign-ups from the shop. Generated from the OpenAPI spec. Each endpoint says which key it needs; see Authentication.
| Method | Path | What it does |
|---|---|---|
| POST | /v1/newsletter/subscribers |
Sign up for the newsletter |
Sign up for the newsletter
Section titled “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
Responses: 202 Accepted · default a problem
Schemas
Section titled “Schemas”Fields marked * are always present in responses and required in requests.
SubscribeNewsletterRequest
Section titled “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 |