Simulate a Manual Lock Action Using a Keypad

• Request Parameters

• Response

Simulates a manual lock action using a keypad. You can only perform this action for August devices within sandbox workspaces.

JavaScript

Simulates a manual lock action using a keypad.

Code

await seam.locks.simulate.manualLockViaKeypad({
  device_id: "d0eed522-8c2f-4905-88fd-4fe8b067bedc",
});

Output

{
  "action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
  "action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Simulates a manual lock action using a keypad.

Code

curl --include --request POST "https://connect.getseam.com/locks/simulate/manual_lock_via_keypad" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "device_id": "d0eed522-8c2f-4905-88fd-4fe8b067bedc"
}
EOF

Output

{
  "action_attempt": {
    "action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
    "action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
    "error": null,
    "result": {},
    "status": "success"
  }
}

Python

Simulates a manual lock action using a keypad.

Code

seam.locks.simulate.manual_lock_via_keypad(
    device_id="d0eed522-8c2f-4905-88fd-4fe8b067bedc"
)

Output

ActionAttempt(
    action_attempt_id="f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
    action_type="SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
    error=None,
    result={},
    status="success",
)

Ruby

Simulates a manual lock action using a keypad.

Code

seam.locks.simulate.manual_lock_via_keypad(device_id: "d0eed522-8c2f-4905-88fd-4fe8b067bedc")

Output

{
  "action_attempt_id" => "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
  "action_type" => "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
  "error" => nil,
  "result" => {
  },
  "status" => "success",
}

PHP

Simulates a manual lock action using a keypad.

Code

<?php
$seam->locks->simulate->manual_lock_via_keypad(
    device_id: "d0eed522-8c2f-4905-88fd-4fe8b067bedc"
);

Output

<?php
[
    "action_attempt_id" => "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
    "action_type" => "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
    "error" => null,
    "result" => [],
    "status" => "success",
];

Seam CLI

Simulates a manual lock action using a keypad.

Code

seam locks simulate manual-lock-via-keypad --device_id "d0eed522-8c2f-4905-88fd-4fe8b067bedc"

Output

{
  "action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
  "action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
  "error": null,
  "result": {},
  "status": "success"
}

Authentication Methods

• API key

• 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 device for which you want to simulate a manual lock action using a keypad.

---

Response

action_attempt

JSON

{
  "action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
  "action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
  "error": null,
  "result": {},
  "status": "success"
}