Files
bookhoard/docs/developer/api/devices/update_device.md
T
John O'Keefe ae9588f1c6 docs(auth,devices): Beam WO5 batch 3 — 15 endpoints backfilled, registry pinned
Beam backfilled auth core (login/register/refresh/logout/profile) and devices
core (list/update/delete/shelf CRUD/sidecar/register flow) with frontmatter,
provenance, and labeled examples. All claimed shapes verified against
handlers: AuthResponse {access_token, refresh_token omitempty, token_type,
expires_in, user}, update device {device_updated, device}, shelf wrappers,
DeviceAuthStatusResponse.

Claude registry verification: 15 entries pinned by type (LoginRequest,
RegisterRequest, AuthResponse, RefreshTokenRequest/Response, UserProfile,
DeviceListResponse, DeviceUpdateRequest, AddToShelfRequest, SidecarConfig,
DeviceRegistrationRequest/Response, DeviceAuthStatusRequest/Response).
Removed revoke_device.md — name-only duplicate of delete_device.md (same
DELETE /api/devices/:id route; was the last audit-orphan doc).

Gate catches this round (subtle Go serialization facts, now pinned in docs):
- uuid.UUID arrays never serialize as omitted: register/status response
  ALWAYS carries device_id (all-zeros while pending) despite omitempty
- update device request binds device_name, not name
- register response includes device_id alongside registration_id
- list devices response is a {devices, total} wrapper
2026-10-24 15:48:18 -04:00

1.6 KiB

method, path, auth, area
method path auth area
PUT /api/devices/:id jwt devices

Update Device

Update a device's information.

Endpoint: PUT /api/devices/:id Auth: Required Content-Type: application/json

Path Parameters

Parameter Type Required Description
id string (UUID) Yes Device UUID

Request Body

Field Type Required Description
name string No Device display name
device_type string No Device type (kobo, koreader, etc.)

Example Request

{
  "device_name": "My Kobo Clara",
  "sync_enabled": true,
  "auto_sync": true,
  "sync_frequency_minutes": 60
}

Response (200 OK)

{
  "device_updated": true,
  "device": {
    "id": "uuid",
    "device_name": "My Kobo Clara",
    "device_type": "kobo",
    "last_sync": null,
    "last_seen": null,
    "sync_enabled": true,
    "auto_sync": true,
    "sync_frequency_minutes": 5,
    "created_at": "2026-02-08T10:00:00Z",
    "auth_token": ""
  }
}

Error Responses

Code Description
400 Invalid request data
401 Invalid or expired token
403 Device does not belong to user
404 Device not found