UBubiquiti
Fob information & management

Patch fob settings

Patch the settings for a specific fob

patch/v1/fobs/{id}

Request

Path parameters

idstring required

The primary key of fob

Example:66d025b301ebc903e80003ea

Request body

namestring

The name of the device.

Example request

{
  "name": "Front Door"
}

Response

Success response

idstring required

The primary key of fob

modelKey'fob' required

The model key of the fob

state'CONNECTED' | 'CONNECTING' | 'DISCONNECTED' required

Connection state of the device.

namestring required

The name of the device.

macstring required

The primary MAC address of the device.

awayState'ONLINE' | 'RECENTLY_SEEN' | 'NO_RECENT_HEARTBEAT' | 'DEVICE_LOST' required

Fob presence/away state.

buttonLabels'securityActions' | 'positionHint' required

Label style applied when this fob is rendered in button selection lists.

Example response

{
  "id": "66d025b301ebc903e80003ea",
  "state": "CONNECTED",
  "name": "Front Door",
  "mac": "24A43C3DFEB9",
  "awayState": "ONLINE",
  "buttonLabels": "securityActions",
  "featureFlags": {
    "buttons": [
      "arm",
      "disarm",
      "panic"
    ]
  },
  "wirelessConnectionState": {
    "signalState": {
      "signalQuality": 85,
      "signalStrength": -45
    },
    "batteryStatus": {
      "percentage": 95
    },
    "bridge": "66d025b301ebc903e80003ea"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.