UserClear the user's call-to-open choice

Clear the user's call-to-open choice

Clears every lock or Matter device chosen to open when the user calls the call-to-open number. Clearing when nothing is chosen changes nothing (event: null). A user acts only for themselves; any partner API key may act for any user. Removing a chosen lock or device from the user's lists drops it from the choice, and clears the choice when it was the last one, without a CallToOpenLockCleared event.

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

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required