Skip to main content

email

Lets Bots in the project send email. It controls email sent by your automations, not the emails Ovok sends on its own behalf.

TypeProject feature
Value in featuresemail
Change withPATCH /v1/projects/me/features (replaces the whole list)
Who can change itProject admin. Any practitioner can read the list.
On for new projectsYes
Needsbots
When offA Bot's attempt to send email is refused with 403

What it enables​

A Bot sends email through the Bot SDK's sendEmail call, which posts to /email/v1/send on the FHIR host. The platform accepts the send only when the Bot's project has email and the caller is a project admin.

Turn it on​

curl --request PATCH \
  --url 'https://api.sandbox.ovok.com/v1/projects/me/features' \
  --header "Authorization: Bearer ${OVOK_TOKEN}" \
  --header 'Content-Type: application/json' \
  --data '{"features":["bots","cron","email","transaction-bundles","websocket-subscriptions"]}'

What this feature does not control​

EmailWhat controls it
Invitations, password resets and other messages Ovok sends itselfNot this feature, and not MAILING_ENABLED. They are sent when the project's email configuration can deliver the message.
Where the links in those emails pointPATIENT_APP_URL and PRACTITIONER_APP_URL

Turning email off therefore does not stop invitation or password-reset emails.

What callers see when it is off​

403 (Forbidden) from /email/v1/send. In a Bot this surfaces as an error from sendEmail.

Gotchas​

  • Two conditions, one 403. The send is refused if the project lacks email or the caller is not a project admin. If a Bot still gets 403 with the feature on, check the Bot's membership as well as the features list.
  • A successful response means "accepted", not "delivered". Delivery depends on the platform's mail configuration, and the call does not report whether a message was actually sent.
  • email without bots is useless. Bots are the only way to reach it. Add bots.
  • Projects created before this was a default can lack it. Call GET /v1/projects/me/features and check.