API reference / Account
POST /v1/account/marketingTurn promotional emails on or off for your account
Appends a consent record (api/consent.py) — the account page's toggle. Turning it ON from a signed-in account also lifts an `unsubscribed` suppression on the address (never a bounce or a provider block): the person is asking, in their own account, to hear from us again. Messages about the account and key are unaffected either way.
X-API-Key
0 credits
curl -X POST 'https://api.puntersedge.online/v1/account/marketing' \
-H 'X-API-Key: YOUR_KEY' \
-H 'Content-Type: application/json' \
-d '{"opt_in": true}'
| Name | In | Type | Required | Description |
|---|---|---|---|---|
opt_in |
body | boolean | yes |
Status codes: 200, 401, 402, 422, 429, 500. Response bodies are JSON; the full schema is in /openapi.json.
200 application/json
— this call costs 0 credits.
Field names and types are as the API returns them; values are a real sample, trimmed to a few items.
{
"terms_accepted_at": "2026-08-14T09:30:11Z",
"terms_source": "signup:free",
"marketing_opt_in": false,
"marketing_changed_at": "2026-09-28T04:40:02Z",
"marketing_source": "console",
"email_suppressed": false,
"suppression_reason": null,
"message": "You will not receive promotional emails. Messages about your account and key still arrive."
}
GET /v1/account — Your account: email, plan, password, billing and consent statusPOST /v1/account/password — Set or change your account passwordGET /v1/billing/overage — Overage: state, rate and ceilingPOST /v1/billing/overage — Switch overage on or offGET /v1/billing/portal — Self-service billing portal linkPOST /v1/billing/portal — Billing portal link (console; confirms your password)GET /v1/billing/upgrade-link — A signed link to your prorated upgrade pagePOST /v1/billing/upgrade-link — Prorated upgrade link (console; confirms your password)The free tier needs no credit card, and the sandbox endpoints need no key at all.
Get a free API key Quickstart