---
title: "Patch chime settings"
method: PATCH
path: "/v1/chimes/{id}"
tags: ["Chime information & management"]
---

# Patch chime settings

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

Patch the settings for a specific chime

## Path parameters

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

## Request body

- object
  - `name` string: The name of the device.
  - `cameraIds` CameraId[]: The list of (doorbell-only) cameras which this chime is paired to.
  - `ringSettings` RingSettings[]: List of custom ringtone settings for (doorbell-only) cameras paired to this chime.
    - `cameraId` string, required: The primary key of camera
    - `repeatTimes` number, required: How many times should the ringtone be repeated
    - `ringtoneId` string, required: The primary key of ringtone
    - `volume` number, required: How loud should the ringtone be played. 0 being silent and 100 the loudest.

## Response `200`

Success response

- Chime
  - `id` string, required: The primary key of chime
  - `modelKey` 'chime', required: The model key of the chime
  - `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.
  - `cameraIds` CameraId[], required: The list of (doorbell-only) cameras which this chime is paired to.
  - `ringSettings` RingSettings[], required: List of custom ringtone settings for (doorbell-only) cameras paired to this chime.
    - `cameraId` string, required: The primary key of camera
    - `repeatTimes` number, required: How many times should the ringtone be repeated
    - `ringtoneId` string, required: The primary key of ringtone
    - `volume` number, required: How loud should the ringtone be played. 0 being silent and 100 the loudest.

## 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)