Offboard Lock Connection

Offboards a Lock Connection, revoking all Keys, removing Locks from Access Groups, and disconnecting from the vendor system.

This is a two-step process to prevent accidental offboarding:

Step 1: Dry-run — Call this endpoint without the confirmationCode query parameter. The response includes an impact summary (number of Locks, Keys, shared Keys, and Doorbells that will be affected) and a confirmationCode that is valid for 5 minutes.

Step 2: Confirm — Call this endpoint again with the confirmationCode from Step 1 as a query parameter. This initiates the offboarding process asynchronously.

Notes:

  • The Lock Connection must be in connected or error state.
  • Offboarding is asynchronous — the Lock Connection state will change to disconnected once the process completes.
  • Each dry-run generates a new confirmation code, invalidating any previous one.
Required Scopeproject.admin
Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here!