/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

JSON body

Request body

application/json

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.

administratorContactExternalIdstringOptional

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.

Response schema

1 status code documented

200Success

successbooleanRequired

Always true on successful update.

Response example

application/json

{
  "success": false
}

Request example

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

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key