await seam.locks.simulate.manualLockViaKeypad({
device_id: "d0eed522-8c2f-4905-88fd-4fe8b067bedc",
});
/*
{
"action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
"action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
"error": null,
"result": {},
"status": "success"
}
*/{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
"status": "pending",
"result": {},
"error": {
"type": "<string>",
"message": "<string>"
}
}
}Simulations
Simulate a Manual Lock Action Using a Keypad
Simulates a manual lock action using a keypad. You can only perform this action for August devices within sandbox workspaces.
POST
/
locks
/
simulate
/
manual_lock_via_keypad
await seam.locks.simulate.manualLockViaKeypad({
device_id: "d0eed522-8c2f-4905-88fd-4fe8b067bedc",
});
/*
{
"action_attempt_id": "f0e1d2c3-b4a5-6d7e-8f90-1a2b3c4d5e6f",
"action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
"error": null,
"result": {},
"status": "success"
}
*/{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SIMULATE_MANUAL_LOCK_VIA_KEYPAD",
"status": "pending",
"result": {},
"error": {
"type": "<string>",
"message": "<string>"
}
}
}Authorizations
api_keypat_with_workspaceconsole_session_with_workspace
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
ID of the device for which you want to simulate a manual lock action using a keypad.
Response
OK
Tracks the progress of this operation. Poll using the action_attempt_id. See the action_attempt object.
Show child attributes
Show child attributes
Was this page helpful?