Get Email Preferences
Your marketing consent, which product email categories you get, and whether you get account reminders.
Returns your marketing consent, your choice for each of the four product email categories, and whether you get account reminders. These settings belong to you, not to a workspace, so they apply across every workspace you're in.
Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan.
Service email — invitations, deprecation notices, stale-page alerts, build, billing and security email — isn't a category here and is always sent. See Email from Syntext.
Response — 200 OK
consent.stategranted (you opted in), soft_opt_in (subscribed by default where the law allows it), denied (no marketing email), or null for accounts that haven't been asked yet. Product email in any of the four product categories goes out only when this is granted or soft_opt_in. Account reminders don't depend on it.consent.atnull.categoriesOne boolean per category, true when you get it. A category you never changed is true.
| Key | Category | What it is |
|---|---|---|
product_tips | Tips | Getting the most out of Syntext |
account_nudges | Check-ins | A note if you haven't used Syntext in a while |
reports | Docs reports | Reports on your docs — stale pages, docs gaps and page views |
news | News | Product announcements |
account | Account reminders | About your own account and sites — finishing setup, a site that's failing, an invite waiting. Not marketing: sent whatever consent.state is |
The first four are product email. account isn't, so it's on even when you haven't opted in to product email — turn it off on its own.
Error Responses
401 Unauthorized
unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.