Unlock an Entrance

• Request Parameters

• Response

Remotely unlocks a specified entrance using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

acs_credential_id String (Required)

ID of the cloud_key credential to use for the unlock operation.

---

acs_entrance_id String (Required)

ID of the entrance to unlock.

---

Response

Returns: action_attempt

JSON

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