---
title: "Update an alarm"
method: PUT
path: "/api/v5/alarms/{alarm_id}"
tags: ["Alarms"]
---

# Update an alarm

`PUT /api/v5/alarms/{alarm_id}`

## Request

- Base URL: `https://api.pavlok.com`
- URL: `https://api.pavlok.com/api/v5/alarms/{alarm_id}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/pavlok/apis/pavlok-api-v5/docs/api/v5/alarms/:alarm_id/put.ts> (a function with typed inputs; its response is checked against the schema)

Update Alarm

## Path parameters

- `alarm_id` integer, required

## Request body

- BodyAlarmsUpdateApiV5AlarmsAlarmIdPut
  - `alarm` AlarmInRequest, required
    - `deviceId` integer
    - `userId` integer, required
    - `habitId` integer
    - `alarmId` string, required
    - `alarmOnDevice` integer
    - `deviceName` string
    - `isOn` boolean
    - `repeatDays` integer[], required
    - `wakeUpTime` string, date-time, required
    - `snoozeConfig` object, required
    - `piezoConfig` object, required
    - `zapConfig` object, required
    - `motorConfig` object, required
    - `deviceWakeupGuarantees` object, required

## Response `200`

Successful Response

- AlarmInResponse
  - `alarm` AlarmMobileFormat, required
    - `deviceId` integer
    - `userId` integer, required
    - `habitId` integer
    - `alarmId` string, required
    - `alarmOnDevice` integer
    - `deviceName` string
    - `isOn` boolean
    - `repeatDays` integer[], required
    - `wakeUpTime` string, date-time, required
    - `snoozeConfig` object, required
    - `piezoConfig` object, required
    - `zapConfig` object, required
    - `motorConfig` object, required
    - `deviceWakeupGuarantees` object, required
    - `id` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/pavlok/apis/pavlok-api-v5.md) - [All operations](https://skmtc.dev/pavlok/apis/pavlok-api-v5/llms.txt) - [OpenAPI document](https://skmtc.dev/pavlok/apis/pavlok-api-v5/revisions/3d192098b1ac?raw)