await seam.locks.simulate.keypadCodeEntry({
device_id: "97a7a706-05a9-405c-91e5-b03e5b9c2003",
code: "1234",
});
/*
{
"action_attempt_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
"error": null,
"result": {},
"status": "success"
}
*/{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
"status": "pending",
"result": {},
"error": {
"type": "<string>",
"message": "<string>"
}
}
}Simulations
Simulate a Keypad Code Entry
Simulates the entry of a code on a keypad. You can only perform this action for August devices within sandbox workspaces.
POST
/
locks
/
simulate
/
keypad_code_entry
await seam.locks.simulate.keypadCodeEntry({
device_id: "97a7a706-05a9-405c-91e5-b03e5b9c2003",
code: "1234",
});
/*
{
"action_attempt_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
"error": null,
"result": {},
"status": "success"
}
*/{
"action_attempt": {
"action_attempt_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"action_type": "SIMULATE_KEYPAD_CODE_ENTRY",
"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
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?