Lock a Lock
Locks a lock. See also Locking and Unlocking Smart Locks.
Locks a lock.
Code:
await seam.locks.lockDoor({
  device_id: "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc",
});Output:
{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}Locks a lock.
Code:
curl --include --request POST "https://connect.getseam.com/locks/lock_door" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc"
}
EOFOutput:
{
  "action_attempt": {
    "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
    "action_type": "LOCK_DOOR",
    "error": null,
    "result": {},
    "status": "success"
  }
}Locks a lock.
Code:
seam.locks.lock_door(device_id="9a31853e-4db0-4d78-b21d-f50c8dbdb9dc")Output:
ActionAttempt(
    action_attempt_id="3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
    action_type="LOCK_DOOR",
    error=None,
    result={},
    status="success",
)Locks a lock.
Code:
seam.locks.lock_door(device_id: "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc")Output:
{
  "action_attempt_id" => "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type" => "LOCK_DOOR",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}Locks a lock.
Code:
$seam->locks->lock_door(device_id: "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc");Output:
[
    "action_attempt_id" => "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
    "action_type" => "LOCK_DOOR",
    "error" => null,
    "result" => [],
    "status" => "success",
];Locks a lock.
Code:
seam locks lock-door --device_id "9a31853e-4db0-4d78-b21d-f50c8dbdb9dc"Output:
{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}Request Parameters
device_id String (Required)
ID of the lock that you want to lock.
Response
{
  "action_attempt_id": "3f2b1c8d-1b5e-4f8c-9c7d-9a8b7c6d5e4f",
  "action_type": "LOCK_DOOR",
  "error": null,
  "result": {},
  "status": "success"
}Last updated
Was this helpful?

