/bff/iot-lock/save-settings

Updates the active/deleted status and administrator assignment for a specific lock. The administrator contact is resolved by external ID and must belong to the same organisation. When an administrator is set, they receive CC on all system notification emails triggered by this lock.

IoTpostBffIot-lockSave-settings

Parameters

4 body

4 total

Body · 4

lockIdnumberRequired

TTLock lock ID (from TTLock API).

activebooleanRequired

Whether the lock should be active. Inactive locks are excluded from status checks and notifications.

deletedbooleanRequired

Whether to soft-delete the lock. Deleted locks are hidden from the list.

administratorContactExternalIdstring

External ID of the contact to assign as lock administrator. The administrator receives email notifications for all critical lock events (gateway offline, battery critical, API errors). Pass empty or omit to remove the administrator.

Request

POST /bff/iot-lock/save-settings

post

curl -X POST "https://api.bizkithub.com/bff/iot-lock/save-settings" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "lockId": 0,
  "active": false,
  "deleted": false,
  "administratorContactExternalId": "example_administratorContactExternalId"
}'

Response

JSON payload

{
  "success": false
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key