Email Preferences

GET /v1/user/email-preferences

Whether your user receives marketing email from Ngris. Marketing email goes out only when you have opted in and your address is not on the suppression list. Account, security and billing email is not marketing and is always sent, whatever these settings say.

Change the opt-in with Update Email Preferences.

Response (200 OK)

marketing_consent boolean
true when you have opted in to marketing email.
suppressed boolean
true when your address is on the marketing suppression list — for example after you used the unsubscribe link in a marketing email. While suppressed, no marketing email is sent even if marketing_consent is true. Opting in again clears it.

Errors

401 Unauthorized
Missing or invalid auth.
500 Internal Server Error
Failed to read preferences.
Request
curl "https://api.ngris.com/v1/user/email-preferences" \ -H "X-API-KEY: <your_api_key>"
Response — 200 OK
{ "marketing_consent": true, "suppressed": false }
On this page
Email Preferences