LockWrite key to lock firmware

Write key to lock firmware

Sends write-key command to device via AWS IoT Shadow to write key data to physical lock hardware. Returns 502 if shadow update fails.

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

Lock ID (numeric)

Content-Typestring
Required

The media type of the request body

Options: application/json
keyUuidstring
Required

Key identifier to write to device firmware

Min length: 1
keyIndexNumberinteger

Physical key index on device

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

idinteger
Required

Lock ID (numeric)

Body

application/json
keyUuidstring
Required

Key identifier to write to device firmware

keyIndexNumberinteger

Physical key index on device

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required