---
title: Unlock a Device's Door
slug: jetstream-v2/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\:kobLJQncO2S0-1ozNf09G)
## Parameters
| **Property** | **Location** | **Details** |
| -------------------------------------------------------------------- | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **AccessKey**
:::BlockQuote
string
Required
Unique
::: | Header | The access key for your user account.
This value is a 36-character GUID provided during [user account sign up](https://jetstreamrfid.com/login/signup). |
| **DeviceName**
:::BlockQuote
string
Required
Unique
::: | URL | The name of the device.
This value has a max length of 128 ASCII characters.
This value must adhere to this regular expression: ^\[a-zA-Z0-9-\_]\*$ |
| **AccessToken**
:::BlockQuote
string
Required
::: | Body | The identifier for a person that will be included in the resulting [AggregateEvent](docId\:h9Wf20q4agQAYlFG4Aobn) - it will appear as the value for the "PassRfid" property.
This value is one of the following: A 10-40 character hexadecimal number, A 36-character GUID
If a 10-40 character hexadecimal number is defined, it needs to be in the access control list of the device. [Get All Passes](docId\:D7J1rXbGYEhBv3BaJwGSP) provides access to a device's access control list. [Add or Remove Passes](docId\:thE3S6MtW3BaEAuUL1A83) provides the ability to make additions and/or deletions to a device's access control list. |
## Example
### Request URL
**POST** https\://api.jetstreamrfid.com/2/devices/\{Device Name}/unlockdoor
### Request Body
:::BlockQuote
\{
"AccessToken": "MyAccessToken"
}
:::
### Response Code
200 OK
### Response Body
:::BlockQuote
\{
"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
"Status": "Completed",
"ExceptionList": \[],
"OutputParameterList": \[]
}
:::
### Published CommandQueuedEvent
:::BlockQuote
\{
"Device": "MyDeviceName",
"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
"CommandName": "UnlockDoor",
"URI": "/2/Devices/MyDeviceName/unlockdoor",
"Verb": "Post",
"User": "MyUserName",
"Parameters": \[
\{
"Key": "AccessToken",
"Value": "MyAccessToken"
}
],
"Type": "CommandQueuedEvent",
"EventId": "80476d30-8d3b-415e-9966-6e5d63876ad9",
"EventTime": "2017-05-18T03:22:37Z"
}
:::
### Published CommandCompletionEvent
:::BlockQuote
\{
"CommandId": "2b50fff0-e84c-42c1-b294-9eb6895684c3",
"CommandName": "UnlockDoor",
"OutputParameterList": \[],
"ExceptionList": \[],
"Device": "MyDeviceName",
"ReceivedTime": "2017-05-18T03:22:54Z",
"Type": "CommandCompletionEvent",
"EventId": "4aa5df90-bfea-49f7-8d69-bce6ba9e21fb",
"EventTime": "2017-05-18T03:22:52Z"
}
:::
## Version Changes
Replaces UnlockDoor