Delete Alarm
Deletes an alarm on the given device. This endpoint is supported for trackers that support alarms.
Scope: settings
Request
| DELETE | /1/user/[user-id]/devices/tracker/[tracker-id]/alarms/[alarm-id].json |
URI Arguments
| user-id | required | The encoded ID of the user. Use "-" (dash) for current logged-in user. |
| tracker-id | required | The ID of the tracker for which the alarm is to be deleted. The tracker-id can be found by using the Get Devices endpoint. |
| alarm-id | required | The ID of the alarm to be deleted. The alarm-id can be found by using the Get Alarms endpoint. |
Request Headers
| authorization | required | Specify the token type and Fitbit user’s access token.
Token type: Bearer |
| accept | optional | Defines the media type of the response content the client is
expecting. Supported: application/json |
| accept-language | optional | The measurement unit system to use for response values. See Localization. |
| accept-locale | optional | The locale to use for response values. See Localization. |
Examples
DELETE https://api.fitbit.com/1/user/-/devices/tracker/755971717/alarms/1240569123.json
DELETE https://api.fitbit.com/1/user/GGNJL9/devices/tracker/755971717/alarms/1240569123.json
DELETE https
curl -X DELETE "https://api.fitbit.com/1/user/-/devices/tracker/755971717/alarms/1240569123.json \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"
Response
Response Headers| content-type | The media type of the response content being sent to
the client. Supported: application/json |
| fitbit-rate-limit-limit | The quota number of calls. |
| fitbit-rate-limit-remaining | The number of calls remaining before hitting the rate limit. |
| fitbit-rate-limit-reset | The number of seconds until the rate limit resets. |
Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.
Response Type
| HTTP Status Code | HTTP response code. List of codes are found in the Troubleshooting Guide. |
| Status Message | Description of the status code. |
| Response Body | Contains the JSON response to the API call. When errors are returned by the API call, the errorType, fieldName and message text will provide more information to the cause of the failure. |
Response Codes
| 204 | A successful request. |
| 400 | The request had bad syntax or was inherently impossible to be satisfied. |
| 401 | The request requires user authentication. |
Note: For a complete list of response codes, please refer to the Troubleshooting Guide.
Additional Information
Device support
The Fitbit devices have the ability to set an alarm. Older devices whose alarms are configured in the mobile application support the create, delete, get and update alarm endpoints. Newer devices, listed in this help article https://help.fitbit.com/articles/en_US/Help_article/1868.htm, contain an on-device alarm application, and do not support the alarm endpoints. The alarms for these devices can only be set on the device itself.
Setting an alarm without a recurring schedule is intended for next day purposes only.
