Unlock a Lock

• Request Parameters

• Response

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

JavaScript

Unlocks a lock.

Code:

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

Output:

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

cURL

Unlocks a lock.

Code:

curl --include --request POST "https://connect.getseam.com/locks/unlock_door" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "be047431-bf00-4da6-9fc7-0a7796a9b57f"
}
EOF

Output:

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

Python

Unlocks a lock.

Code:

seam.locks.unlock_door(device_id="be047431-bf00-4da6-9fc7-0a7796a9b57f")

Output:

ActionAttempt(
    action_attempt_id="5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    action_type="UNLOCK_DOOR",
    error=None,
    result={},
    status="success",
)

Ruby

Unlocks a lock.

Code:

seam.locks.unlock_door(device_id: "be047431-bf00-4da6-9fc7-0a7796a9b57f")

Output:

{
  "action_attempt_id" => "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
  "action_type" => "UNLOCK_DOOR",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Unlocks a lock.

Code:

$seam->locks->unlock_door(device_id: "be047431-bf00-4da6-9fc7-0a7796a9b57f");

Output:

[
    "action_attempt_id" => "5f4e3d2c-1b0a-9f8e-7d6c-5b4a3c2d1e0f",
    "action_type" => "UNLOCK_DOOR",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Unlocks a lock.

Code:

seam locks unlock-door --device_id "be047431-bf00-4da6-9fc7-0a7796a9b57f"

Output:

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

Authentication Methods

• API key

• Client session token

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

device_id String (Required)

ID of the lock that you want to unlock.

---

Response

action_attempt

JSON

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