Skip to main content

Send support message

MethodPath
POST/v1/slim/user/support

Authentication · Access policies

Sends a support email on behalf of the signed-in user to the support address configured for this Ovok environment.

Auth: Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant Patient:read, Patient:search, Device:read, Device:search, Observation:read and Observation:search (project admins skip this check). Scope: The caller's project (from the token).

Behaviour​

  • Sends one email built from the message, version and environment you send.
  • The email also carries details taken from your session, not from the body: your name, email, project name, profile type, access policy name and tenant code.
  • Nothing else is written.
  • Returns true once the email is sent.

Example​

curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/support' \
-H "Authorization: Bearer ${OVOK_TOKEN}" \
-H 'Content-Type: application/json' \
-d '{ "message": "The live view does not load.", "version": "1.8.0", "environment": "production" }'

Successful response​

201 — Support message sent. The body is true.

Errors​

StatusMeaning
400The support address is not configured, or the session carries no project.
401The bearer token is missing or invalid.
403The session is not a practitioner, admin or System Owner session, or its access policy lacks one of the listed interactions.
422The body fails validation.