# Send support message

Canonical page: https://docs.ovok.com/slim-apis/user/send-support-message

| Method | Path |
| --- | --- |
| `POST` | `/v1/slim/user/support` |

[Authentication](/authentication) · [Access policies](/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).

## Request [#request]

### Body [#body]

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `message` | `string` | Yes | The support request text. At least 1 character. |
| `version` | `string` | Yes | Version of the app the message comes from, for example `1.8.0`. At least 1 character. |
| `environment` | `string` | Yes | Environment the app runs against, for example `production`. At least 1 character. |

```json
{
  "message": "The live view does not load.",
  "version": "1.8.0",
  "environment": "production"
}
```

## Behaviour [#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.
- If no support address is configured for the environment, or the session carries no project, the request fails with 400 and nothing is sent.
- If the email cannot be sent, the request fails with 500.
- Returns `true` once the email is sent.


## Example [#example]

```bash
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 [#successful-response]

`201` — Support message sent. The body is `true`.

```json
true
```

| Field | Type | Description |
| --- | --- | --- |
| (response body) | `boolean` | The JSON value `true`. It is not wrapped in an object. A message that was not sent returns an error status instead. |

## Errors [#errors]

| Status | Meaning |
| --- | --- |
| [`400`](/errors/malformed-request) | The support address is not configured, or the session carries no project. |
| [`401`](/errors/unauthenticated) | The bearer token is missing or invalid. |
| [`403`](/errors/forbidden) | The session is not a practitioner, admin or System Owner session, or its access policy lacks one of the listed interactions. |
| [`422`](/errors/validation-failed) | The body fails validation, for example `message`, `version` or `environment` is missing or empty. |
| [`500`](/errors/internal-error) | The email could not be sent. |
| [`503`](/errors/service-unavailable) | Your access policy could not be read, or the service is temporarily over capacity. Retry shortly, and honour `Retry-After` when it is present. |
