---
title: Unlock a Device's Door
slug: jetstream-v3/unlock-a-devices-door
docTags: 
createdAt: 2024-01-23T15:35:09.721Z
---

## About

Instructs the specified device to unlock its door. The door will remain unlocked for the duration defined by the DoorUnlockTimeLimit configuration setting of the device’s policy.

| **Command Type**           | **Device is Online**                                         | **Device is Offline** |
| -------------------------- | ------------------------------------------------------------ | --------------------- |
| Synchronous, Not Queueable | Immediate execution, Immediate results and Published results | Failure to execute    |

Applicable to the following device types: [RFID Enclosures (Cabinets, Fridges, Freezers)](docId\:uXZf6DdOf1T2zGZzjH9M6)

## Parameters

| **Property**                                                         | **Location** | **Details**                                                                                                                                                                                                                                                                                                                                                                                      |
| -------------------------------------------------------------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **AccessKey**<br />:::BlockQuote
string&#xA;Required&#xA;Unique
:::  | Header       | The access key for your user account.<br />This value is a 36-character GUID provided in your [user profile](docId\:BbIFQiuIXND5iAfMreBBi).                                                                                                                                                                                                                                                      |
| **DeviceName**<br />:::BlockQuote
string&#xA;Required&#xA;Unique
::: | URL          | The name of the device.<br />This value has a max length of 128 ASCII characters.<br />This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_,. ]\*$                                                                                                                                                                                                                                 |
| **AccessToken**<br />:::BlockQuote
string&#xA;Required
:::           | Body         | The identifier for a person that will be included in the resulting [AggregateEvent](docId\:aTQjfemFM4z9hiTJAIepK)- it will appear as the value for the "PassRfid" property.<br />This value is one of the following: A 10-40 character hexadecimal number, A 36-character GUID<br />If a 10-40 character hexadecimal number is defined, it needs to be in the access control list of the device. |

## Example

### Request URL

**POST** https\://api.jetstreamrfid.com/3/devices/\{Device Name}/unlockdoor

### Request Body

:::BlockQuote
\{
&#x9;"AccessToken": "MyAccessToken"
}
:::

### Response Code

200 OK

### Response Body

:::BlockQuote
\{
&#x9;"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
&#x9;"Status": "Completed",
&#x9;"ExceptionList": \[],
&#x9;"OutputParameterList": \[]
}
:::

### Published CommandQueuedEvent

:::BlockQuote
\{
&#x9;"Device": "MyDeviceName",
&#x9;"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
&#x9;"CommandName": "UnlockDoor",
&#x9;"URI": "/3/Devices/MyDeviceName/unlockdoor",
&#x9;"Verb": "Post",
&#x9;"User": "MyUserName",
&#x9;"Parameters": \[
&#x9;	\{
&#x9;		"Key": "AccessToken",
&#x9;		"Value": "MyAccessToken"
&#x9;	}
&#x9;],
&#x9;"Type": "CommandQueuedEvent",
&#x9;"EventId": "80476d30-8d3b-415e-9966-6e5d63876ad9",
&#x9;"EventTime": "2018-05-18T03:22:37Z",
&#x9;"Version":3
}
:::

### Published CommandCompletionEvent

:::BlockQuote
\{
&#x9;"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
&#x9;"CommandName": "UnlockDoor",
&#x9;"OutputParameterList": \[],
&#x9;"ExceptionList": \[],
&#x9;"Device": "MyDeviceName",
&#x9;"ReceivedTime": "2017-05-18T03:22:54Z",
&#x9;"Type": "CommandCompletionEvent",
&#x9;"EventId": "4aa5df90-bfea-49f7-8d69-bce6ba9e21fb",
&#x9;"EventTime": "2018-05-18T03:22:52Z",
&#x9;"Version":2
}
:::

## Version Changes

Added Version Property to Events.