/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Get Email Preferences

Get Email Preferences

Your marketing consent, which product email categories you get, and whether you get account reminders.

GET/v1/me/email-preferencesTry it
Session token

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.

Note

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

NameDescription
consent.state:string | nullbody
granted (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.at:string | nullbody
When the consent was last recorded, or null.
categories:objectbody

One boolean per category, true when you get it. A category you never changed is true.

KeyCategoryWhat it is
product_tipsTipsGetting the most out of Syntext
account_nudgesCheck-insA note if you haven't used Syntext in a while
reportsDocs reportsReports on your docs — stale pages, docs gaps and page views
newsNewsProduct announcements
accountAccount remindersAbout 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.

Was this page helpful? Yes No
Request
cURLJavaScriptPythonGoRubyPHPJavaC#cURL
curl https://api.syntext.dev/v1/me/email-preferences \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
200OK
{
"data": {
"consent": { "state": "soft_opt_in", "at": "2026-11-14T09:12:44.000Z" },
"categories": {
"product_tips": true,
"account_nudges": true,
"reports": true,
"news": false,
"account": true
}
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext