API Reference
Dashboard
  1. API Reference
  2. Box API
  3. Modems

Add or change the free-text note of a modem

Use this to attach a note (owner, SIM plan, location) to a modem. Stored in the box database by device id, so it follows the modem if it moves to another slot. No reboot.

  • Destructive · confirm first
  • Basic auth
  • Panel API · since v20.8.0
  • Hub: routine call
  • changeDeviceNote
POST/v2/change_device_note

Request body application/json · required

positionintegerrequired
notestringrequired

Authentication

Needs dashboard Basic credentials when dashboard authentication is enabled; trusted callers (loopback, LAN unless "force auth for local" is on, whitelisted IP, allowed Tailscale) pass without them.

Responses

Result.

statusbooleanrequired

True when the box accepted the request.

msgstringrequired

Outcome code or message (see the operation's error table).

Errors returned in msg

msgMeaningWhat to do
Sent change device note failed. Please try again later!No modem at the position or a field is missing.Use a position that holds a modem and send note.
Verified against XProxy v21.3.2 on Nov 17, 2026