Serial templates API

GET/v1/serial-templates

List saved RS232 serial command templates for your workspace, such as profiles for turning a display on or switching its input. Each template includes the exact bytes each command sends. **Notes.** - Not paginated. Only templates at locations where the key has screen.view are listed.

curl "https://api.brixsignage.com/v1/serial-templates" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/serial-templates

Create an RS232 command template. Provide a name, an optional model, an items array of commands each with name, value, encoding (ascii or hex), and eol, and an optional nodeId.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/serial-templates" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Sony Bravia","model":"FW-55BZ35","items":[{"name":"Power on","value":"*SCPOWR0000000000000001","encoding":"ascii","eol":"lf"}]}'

Response 201 Success.

{
  "data": {
    "id": "sertpl_2b3c4d5e6f7a8b9c",
    "spaceId": "space_1a2b3c4d5e6f7a8b",
    "name": "Sony Bravia",
    "model": "FW-55BZ35",
    "nodeId": null,
    "createdAt": "2026-09-28T09:00:00.000Z",
    "updatedAt": "2026-09-28T09:00:00.000Z",
    "items": [
      {
        "id": "sti_3c4d5e6f7a8b9c0d",
        "name": "Power on",
        "value": "*SCPOWR0000000000000001",
        "encoding": "ascii",
        "eol": "lf",
        "hexPreview": "2A 53 43 50 4F 57 52 30 30 30 30 30 30 30 30 30 30 30 30 30 30 30 31 0A"
      }
    ]
  }
}

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 422 `name` is missing, `invalid_node` (the location is not in this workspace), or a command is not valid (no name, no value, too long, no bytes, a duplicate id, over 200 commands); `message` names it.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/serial-templates/{id}

Get one RS232 command template, including a preview of the exact bytes each command will send to the device.

curl "https://api.brixsignage.com/v1/serial-templates/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such serial template in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/serial-templates/{id}

Update an RS232 command template's name, model, organization node, or list of commands. Existing command IDs are preserved, so anything referencing a specific command continues to work.

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/serial-templates/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 No `screen.edit` at the destination location.

Response 404 No such serial template in this workspace.

Response 422 An empty `name`, `invalid_node` (the destination is not in this workspace), or a command is not valid; `message` names it.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/serial-templates/{id}

Delete an RS232 command template. Commands already queued using this template are unaffected, because they carry their own fully expanded bytes rather than a reference to the template. **Notes.** - Answers { data: { ok: true } }, not the { id, deleted: true } most other deletes return. There is no restore route.

curl -X DELETE "https://api.brixsignage.com/v1/serial-templates/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such serial template in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.