- API Reference
- Box API
- 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.
POST
/v2/change_device_noteRequest 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).
The caller is not trusted (not loopback, LAN, whitelisted or allowed Tailscale) and sent no valid Basic credentials. The body depends on whether "Basic auth for all API" is on. Routes that also use the panel login can answer a plain-text 401 "Unauthorized Access" instead.
Errors returned in msg
| msg | Meaning | What 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. |