/api/v1/lock/unlock

Sends an immediate remote unlock command to the specified lock via the TTLock API. The lock is identified by its TTLock lock ID (external identifier). Requires an active, non-deleted lock connected to a Wi-Fi gateway.

IoTpostApiV1LockUnlock

Parameters

2 query

Query parameters

· 2

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

lockIdstringRequired

TTLock lock ID (external identifier).

Example12345

Response schema

1 status code documented

200Success

successbooleanRequired

True if the unlock command was sent successfully.

Response example

application/json

{
  "success": false
}

Request example

POST /api/v1/lock/unlock

post

curl -X POST "https://api.bizkithub.com/api/v1/lock/unlock?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE&lockId=12345" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key