---
title: "Patch fob settings"
method: PATCH
path: "/v1/fobs/{id}"
tags: ["Fob information & management"]
---

# Patch fob settings

`PATCH /v1/fobs/{id}`

## Request

- Base URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration`
- URL: `https://api.ui.com/v1/connector/consoles/942A6FF664C0000000000964970E0000000009E710560000000068A9873F:9999999999/proxy/protect/integration/v1/fobs/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/fobs/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Patch the settings for a specific fob

## Path parameters

- `id` string, required: The primary key of fob

## Request body

- object
  - `name` string: The name of the device.

## Response `200`

Success response

- Fob
  - `id` string, 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.
  - `name` string, required: The name of the device.
  - `mac` string, 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.
  - `featureFlags` FobFeatureFlags, required: Feature flags for the fob.
    - `buttons` string[], required: Available button types on the fob.
  - `wirelessConnectionState` WirelessConnectionState, required: Wireless connection state including signal quality, battery status, and bridge connection.
    - `signalState` SignalState, required: Signal state.
      - `signalQuality` number, nullable, required: Percent representation of Bluetooth signal strength.
      - `signalStrength` number, nullable, required: dBm value of Bluetooth signal strength.
    - `batteryStatus` WirelessBatteryStatus, required: Battery status.
      - `percentage` number, nullable, required: Battery charge level from 0 to 100 (%).
      - `isLow` boolean, required: Low battery charge level flag.
    - `bridge` string, required: The primary key of bridge

## Other responses

- `default`: Error response

---

[API](https://skmtc.dev/ubiquiti/apis/unifi-protect-api.md) - [All operations](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/llms.txt) - [OpenAPI document](https://skmtc.dev/ubiquiti/apis/unifi-protect-api/revisions/e341e1381db1?raw)