Switch a Matter device's alarm pushes on or off
Sets the device's alarm mode for every user of the device. While enabled is false, no AlarmTriggered or AlarmCleared of the device sends a push (each is still recorded, with alarmsEnabled: false, and logged as suppressed / alarms-off); turning alarms back on sends nothing until the next transition. Setting the mode the device already has records nothing (event: null). An organization API key may set it; a user's token only for a Matter device the user has linked.
curl -X POST "https://api.spkey.co/matter-devices/example_string/SetAlarmMode" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"enabled": true
}'
import requests
import json
url = "https://api.spkey.co/matter-devices/example_string/SetAlarmMode"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"enabled": true
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/matter-devices/example_string/SetAlarmMode", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"enabled": true
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"enabled": true
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/matter-devices/example_string/SetAlarmMode", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/matter-devices/example_string/SetAlarmMode')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"enabled": true
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/matter-devices/{id}/SetAlarmModeTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
Matter Device ID
The media type of the request body
The device's alarm mode: false = no alarm push to any of its users; true = alarms are pushed (the default)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
Matter Device ID
Body
The device's alarm mode: false = no alarm push to any of its users; true = alarms are pushed (the default)
Responses
The AlarmModeSet just recorded, or null when the device already had that mode