Simulate a Keypad Code Entry

• Request Parameters

• Response

Simulates the entry of a code on a keypad. You can only perform this action for August devices within sandbox workspaces.

JavaScript

Simulates the entry of a code on a keypad.

Code:

await seam.locks.simulate.keypadCodeEntry({
  device_id: "97a7a706-05a9-405c-91e5-b03e5b9c2003",
  code: "1234",
});

Output:

{
  "action_attempt_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
  "error": null,
  "result": {},
  "status": "success"
}

cURL

Python

Ruby

PHP

Seam CLI

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

code String (Required)

Code that you want to simulate entering on a keypad.

---

device_id String (Required)

ID of the device for which you want to simulate a keypad code entry.

---

Response

Returns: action_attempt

JSON

{
  "action_attempt_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
  "error": null,
  "result": {},
  "status": "success"
}