---
title: "Send support message"
method: POST
path: "/v1/contact"
tags: ["contact"]
---

# Send support message

`POST /v1/contact`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/contact`
- Auth: HTTP bearer

Sends a message to Brix, for example through a "Send message / report a problem" dialog. Provide `subject` and `message`, and optionally `source` and `sourcePath` to indicate where the message was sent from. The sender is always the caller (the signed-in person or the API key), never taken from the request body. Limited to 10 requests per minute.

**Notes.**
- The sender is always the caller; an `email` field in the body is ignored.

## Request body

- object
  - `subject` string, required: Trimmed; 1–200 characters.
  - `message` string, required: Trimmed; 1–5000 characters.
  - `source` string: A tag for where the message came from (cut at 500 characters).
  - `sourcePath` string: The page the sender was on (cut at 500 characters).

## Response `201`

Success.

- object
  - `data` object, required
    - `id` string, required
    - `emailSent` boolean, required
    - `closeNoted` boolean, required: The message was also added to the workspace's record in the Brix customer system.
    - `warnings` string[], required: `email_not_sent`, `close_note_failed`. The message is stored either way.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `404`: The workspace or the sender could not be resolved.
- `422`: `subject` or `message` is empty or too long.
- `429`: More than 10 messages a minute.
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)
