Unlock a Lock

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"
}
*/

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

POST

locks

unlock_door

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"
}
*/

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

Authorizations

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.

Response

action_attempt

object

required

Tracks the progress of this operation. Poll using the action_attempt_id. See the action_attempt object.

Show child attributes

Lock door Keypad code entry

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Unlock a Lock

Authorizations

Body

Response