Quickstart

Send structured display messages to boards via a single HTTP endpoint. Authenticate with an API key, target specific panels, and control layout rendering.

Steps

1. Sign in and open the admin portal.
2. Create a board — you'll receive a signed board ID.
3. Issue an API key under the Tokens section.
4. Bind a display device to the board using the mobile app.
5. Send your first API request (see below).

Your first request

Once you have a board ID and API key, send a display update:

curl -X POST https://api.pushtodisplay.com/api/v1/updates \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: <your-api-key>" \
  -d '{
  "boardId": "<signed-board-id>",
  "blocks": [
    {
      "text": "Hello, Display!",
      "size": "large",
      "weight": "bold"
    }
  ]
}'

A successful request returns 202 Accepted:

{
  "messageId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "enqueuedAtUtc": "2026-04-14T12:00:00Z",
  "userId": "user-abc"
}

The message is queued for delivery to all devices currently registered to the target board.