MatterDeviceSwitch a Matter device's alarm pushes on or off

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
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/matter-devices/{id}/SetAlarmMode
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
path
idstring
Required

Matter Device ID

Content-Typestring
Required

The media type of the request body

Options: application/json
enabledboolean
Required

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

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

idstring
Required

Matter Device ID

Body

application/json
enabledboolean
Required

The device's alarm mode: false = no alarm push to any of its users; true = alarms are pushed (the default)

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required

The AlarmModeSet just recorded, or null when the device already had that mode