OVOK DOCS
Get startedOvokSignalsSDKsGuidesAPI referenceDeveloper resources
SlimSlim/User

Send support message

  • Sandbox: available
  • Staging: available
  • Production: unknown
POST
/v1/slim/user/support

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 (a project admin who holds no access policy skips 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 eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \  -H 'Content-Type: application/json' \  -d '{ "message": "The live view does not load.", "version": "1.8.0", "environment": "production" }'

Authorization

bearer
headerAuthorizationBearer <JWT>

Request Body

application/json
  1. body
message*string
Length1 <= length
version*string
Length1 <= length
environment*string
Length1 <= length

Response Body

Support message sent. The body is true.

response?booleanapplication/json
Example Request
curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/support' \  -H 'Content-Type: application/json' \  -d '{  "message": "string",  "version": "string",  "environment": "string"}'
Example Response
true

Update user consents POST

Updates one or more consents of the signed-in practitioner. Use it to save the answers of a combined consent prompt. **Auth:** Bearer token for a practitioner session (the profile must be a `Practitioner`). The caller's access policy must grant `Consent:read`, `Consent:search`, `Consent:create` and `Consent:update` (a project admin who holds no access policy skips this check). **Scope:** The caller's practitioner profile in the caller's project (from the token). ## Behaviour - Send at least one of `medicalSettingsNotificationsConsent` and `termsAndConditionsConsent`. Only the fields you send change. - `true` records acceptance of the currently published version of that consent. `false` withdraws it. - A `termsAndConditionsConsent` change also creates, re-activates or revokes the legal `Consent` read by `GET /v1/me/consent/legal`. - All changes commit together or not at all. Repeating the same values writes nothing. - The consent answers of `/v1/me/consent/*` are refreshed right away. - The response always carries the resulting state of every consent. ## Example ```bash curl -X POST 'https://api.sandbox.ovok.com/v1/slim/user/consents' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' \ -H 'Content-Type: application/json' \ -d '{ "medicalSettingsNotificationsConsent": true, "termsAndConditionsConsent": true }' ```

Delete user DELETE

Removes a practitioner from a project: deletes their membership and practitioner profile, and their user account when this was their last membership. Use it to offboard a team member. **Auth:** Bearer token for a practitioner, project admin or System Owner session. The caller's access policy must grant `Practitioner:delete` (a project admin who holds no access policy skips this check). **Scope:** The practitioner's project must be the caller's project (from the token) or a direct child of it. ## Behaviour - `profileType` must be `Practitioner` and `profileId` a UUID. - The membership, the practitioner and, when it has no other membership, the user are deleted together or not at all. - The owner of the caller's own project cannot be deleted. The owner of a child project can. - After the delete, an account-deletion email is sent to the user's email address, if they have one. A failed email does not fail the request. - Returns `{ "success": true }`. ## Example ```bash curl -X DELETE 'https://api.sandbox.ovok.com/v1/slim/user/Practitioner/c3499c27-2973-0a7f-807e-fb8676a92dcb' \ -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE3NjcyNjg4MDAsImV4cCI6MTc2NzI3MjQwMH0.Ql3B_ztDvctlyZ2z0vp4sl3ExXRQGkzmxdmTAqxNzZk' ```