---
title: "Patch siren settings"
method: PATCH
path: "/v1/sirens/{id}"
tags: ["Siren information & management"]
---

# Patch siren settings

`PATCH /v1/sirens/{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/sirens/{id}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/ubiquiti/apis/unifi-protect-api/docs/v1/sirens/:id/patch.ts> (a function with typed inputs; its response is checked against the schema)

Patch the settings for a specific siren

## Path parameters

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

## Request body

- object
  - `name` string: The name of the device.
  - `volume` integer: Volume: a number from 1-100.
  - `ledSettings` SirenLedSettingsExternal: Status LED settings.
    - `isEnabled` boolean, required: Enable status LED.

## Response `200`

Success response

- Siren
  - `id` string, required: The primary key of siren
  - `modelKey` 'siren', required: The model key of the siren
  - `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.
  - `volume` integer, required: Volume: a number from 1-100.
  - `ledSettings` SirenLedSettingsExternal, required: Status LED settings.
    - `isEnabled` boolean, required: Enable status LED.
  - `sirenStatus` SirenStatus, required: Status of the siren
    - `isActive` boolean, required: Whether the siren is active.
    - `activatedAt` number, nullable, required: Timestamp when the siren was activated.
    - `duration` union, required: Duration of the siren activation in milliseconds.
      - 5000
      - 10000
      - 20000
      - 30000
  - `connectionType` 'ucp4' | 'lora', required: The connection type of the siren.
  - `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)