v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-02-1354131442.5 KB

settings

Update reel identification information

Update reel serial number and/or display name with role-based permissions

patch/api/v1/reel/info

Request body

serial_numberstring nullable

New serial number for the reel system.

Only system administrators can update this field. Will be ignored if user lacks sys_admin role.

display_namestring nullable

New display name for the reel system.

Any authenticated user can update this field. Must be between 1-100 characters.

Example request

{
  "description": "Any user can update display name",
  "name": "Update Display Name Only",
  "value": {
    "display_name": "Smart Winch - Dock 3"
  }
}

Response

Successful Response

actionstring required

The action that was requested or performed by the endpoint

errorboolean required

Indicates whether the operation encountered an error

error_msgsstring[]

List of error messages if the operation failed

Example response

{
  "description": "User updated display name",
  "name": "Display Name Updated Successfully",
  "value": {
    "action": "UPDATE_REEL_INFO",
    "error": false,
    "error_msgs": [],
    "result": {
      "reel_info": {
        "display_name": "Smart Winch - Dock 3",
        "serial_number": "UNSET",
        "uuid": "3f930e75-5672-4275-839b-c6a5cbae454a"
      },
      "warnings": []
    }
  }
}