Lock a Lock

await seam.locks.lockDoor({
  device_id: "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc",
});

/*
{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}
*/

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

POST

locks

lock_door

await seam.locks.lockDoor({
  device_id: "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc",
});

/*
{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}
*/

{
  "action_attempt": {
    "action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "action_type": "LOCK_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 lock.

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

List Unlock door

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Lock a Lock

Authorizations

Body

Response