UserMute or unmute push notifications for a device, for this user only

Mute or unmute push notifications for a device, for this user only

Sets pushMuted on the user's linked device. Alarm pushes for that device skip this user; other users who share the device are unaffected. API-key callers can only change devices of their own organisation.

curl -X POST "https://api.spkey.co/users/example_string/SetDevicePushMuted" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "deviceId": "example_string",
  "muted": true
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/users/{id}/SetDevicePushMuted
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.
Content-Typestring
Required

The media type of the request body

Options: application/json
deviceIdstring
Required

Linked device to mute/unmute push for

mutedboolean
Required

true to mute push for this device, false to unmute

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

Body

application/json
deviceIdstring
Required

Linked device to mute/unmute push for

mutedboolean
Required

true to mute push for this device, false to unmute

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required