Unlock a Lock

Unlocks a lock. See also Locking and Unlocking Smart Locks.

POST /locks/unlock_door

JavaScript

Seam SDK

await seam.locks.unlockDoor({
  device_id: "be047431-bf00-4da6-9fc7-0a7796a9b57f",
});

/*
{
  "action_attempt_id": "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
  "action_type": "UNLOCK_DOOR",
  "error": null,
  "result": {
    "was_confirmed_by_device": false
  },
  "status": "success"
}
*/

200

{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "result": {},
    "error": {
      "type": "<string>",
      "message": "<string>"
    }
  },
  "ok": true
}

Authorizations

client_sessionclient_session_with_customerpat_with_workspaceconsole_session_with_workspaceapi_key

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

device_id · string<uuid> · required

ID of the lock that you want to unlock.

sync · boolean · default: false

Response

200

application/json

OK

action_attempt · object · required

Tracks the progress of this operation. Poll using the action_attempt_id.

Show child attributes

ok · boolean · required