Skip to main content

MAILING_ENABLED

A reserved Boolean setting. Ovok accepts and stores it, but no Ovok route reads it today: turning it on or off changes nothing.

TypeBoolean setting
Change withPUT /v1/project/settings/MAILING_ENABLED
Who can change itProject admin
When unsetReads as false; the value has no effect either way
Set on new projectsNot set by any project-creation route
Effect todayNone

Why it is listed​

MAILING_ENABLED is one of the keys that GET /v1/project/settings returns and PUT /v1/project/settings/:key accepts. It appears in the settings record of every project, so dashboards and generated clients see it. Do not use it to switch email on or off.

curl --get 'https://api.sandbox.ovok.com/v1/project/settings' \
  --header "Authorization: Bearer ${OVOK_TOKEN}"

What actually controls email​

EmailWhat controls it
Email sent by an automation (Bot)The email project feature.
Invitations, password resets and other messages Ovok sends itselfNo project switch. They are sent when the project's email configuration can deliver the message.

If Ovok cannot send an invitation email, most invitation routes undo the invitation rather than leave an account nobody can reach, and report it differently: POST /auth/invite, POST /v1/projects/me/members and POST /v1/saas/register answer 500, and POST /v1/invites/* still answers 202. POST /v1/slim/invite/practitioner is the exception: it creates the account and succeeds even when no email could be sent. See PATIENT_INVITATION_ENABLED and PRACTITIONER_INVITATION_ENABLED.

To control where the links in those emails point, set PATIENT_APP_URL and PRACTITIONER_APP_URL.

Gotchas​

  • A true value is not a promise. Setting it does not enable mailing, and setting it to false does not stop mail.
  • Do not build your own logic on it. Its meaning is not defined, so treat the current value as meaningless.
  • Writes still follow the normal rules. Admin only, and a concurrent change answers 409; read the settings again and retry.