Update desired shadow

Sets desired shadow state and pushes to AWS IoT Core. An organization API key may send any desired write. A user's token (the mobile app) may send only to a device in the user's devices (GET /users/{id}/devices, deviceType matter), and only a Scenario Engine command (scenario_upsert, scenario_remove, scenario_set_status); the scenario's creator is the token's user.

curl -X POST "https://api.spkey.co/matter-devices/example_string/UpdateDesiredShadow" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "desired": {},
  "requestedByUserId": "example_string"
}'

import requests
import json

url = "https://api.spkey.co/matter-devices/example_string/UpdateDesiredShadow"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
}
data = {
  "desired": {},
  "requestedByUserId": "example_string"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.spkey.co/matter-devices/example_string/UpdateDesiredShadow", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN (JWT)",
  "X-API-Key": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "desired": {},
  "requestedByUserId": "example_string"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "desired": {},
  "requestedByUserId": "example_string"
}`)

    req, err := http.NewRequest("POST", "https://api.spkey.co/matter-devices/example_string/UpdateDesiredShadow", 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/UpdateDesiredShadow')
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 = '{
  "desired": {},
  "requestedByUserId": "example_string"
}'

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"
    }
  ]
}

POST

/matter-devices/{id}/UpdateDesiredShadow

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.

API Key (header: X-API-Key)

X-API-Keystring

Required

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

Matter Device ID

The media type of the request body

Options: application/json

desiredobject

Required

Desired shadow state to push to device

requestedByUserIdstring

App user the write is made for. Recorded on the event only, never written to the shadow. For a Scenario Engine command, the creator of the scenario: SpacetimeDB shows it to that user. With a user's token it may be left out (the token's user is used) and must otherwise be that user; with an organization API key it names the user, or is left out.