Claim an unclaimed device | TRMNL Octri Demo

1 body field

friendly_idstringrequired

The code shown on the device during setup

5 status codes

200Claimed

dataobjectoptional

400friendly_id is missing

errorstringoptional

401Unauthorized

errorstringoptional

422A concurrent claim already took the device

errorstringoptional

429Too many failed claims from this account or address

errorstringoptional

Error handling

A 400 is returned: friendly_id is missing. A 401 is returned: Unauthorized. A 422 is returned: A concurrent claim already took the device. A 429 is returned: Too many failed claims from this account or address.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.devices.create({ friendlyId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "data": {
    "auto_advance": true,
    "battery_voltage": 3.7,
    "firmware_channel": "production",
    "firmware_version": "1.8.14",
    "friendly_id": "ABC-123",
    "hardware_last_ping_at": "2026-03-31T14:30:00.000Z",
    "id": 123,
    "last_ping_at": "2026-03-31T14:30:00.000Z",
    "low_battery_notification_enabled": true,
    "mac_address": "••:••:••:••:9A:BC",
    "mashup_layouts": {
      "1Lx1R": [
        "a",
        "b"
      ],
      "2x2": [
        "a",
        "b",
        "c",
        "d"
      ]
    },
    "name": "My TRMNL",
    "orientation": 0,
    "ota_enabled": true,
    "percent_charged": 85,
    "pinned_firmware_version": "1.8.14",
    "refresh_interval": 900,
    "rssi": -70,
    "sleep_end_time": 480,
    "sleep_mode_enabled": false,
    "sleep_screen_enabled": true,
    "sleep_start_time": 1320,
    "sleep_until": "2026-10-01T15:00:00.000Z",
    "wifi_band": "5",
    "wifi_strength": 75
  }
}

Request

Response

Errors