Skip to main content

Portal-How to Add-Install-Connect/Remove-Uninstall-Disconnect a lock via the Portal app

This article explains how staff can install a lock on a door using the Portal Staff App. Staff must have the correct permissions to complete this process.

Written by Sarah Mousavi
Updated over 3 weeks ago

Overview

Locks are installed using the Portal Staff App and linked to doors in Portal.
This article explains how to log in, create a door, select the correct device type, and complete lock installation using Bluetooth.


Before You Start

Before installing a lock, make sure:

  • You have access to the Portal Staff App

  • You use the same login credentials as the Portal Dashboard

  • You have permission to install locks

  • The lock has battery power and is nearby


Key Concepts

  • Portal Staff App: Mobile app used for lock installation and on-site actions.

  • Door: A digital representation of a physical access point.

  • Device Type: The hardware model selected during installation.

  • Bluetooth (BLE): Used to detect and install locks.


How to Install a Lock

Log In to the Portal Staff App

Staff must use their Portal Dashboard credentials.

  1. Open the Portal Staff App.

  2. Log in using your Portal Dashboard email and password.

  3. Confirm you have permission to install locks.


Create a Door in the Portal Staff App

NOTE: If you have already imported rooms from PMS/Created manually, skip this step.

Each lock must be linked to a door.

  1. Open the Doors tab.

  2. Tap the + (Add) button.

  3. Select a Door Type.

  4. Enter a Door Name.

  5. Tap Add.


Select the Device Type

After creating the door, choose the correct hardware model.

  1. Select the Device Type.

  2. Choose the hardware model that matches the lock.

This ensures correct communication between the app and the lock.


Install the Lock via Bluetooth

Complete the installation by connecting to the lock.

  1. Stay within Bluetooth range of the lock.

  2. Allow the app to search for nearby locks.

  3. Select the lock when it appears.

  4. Follow the on-screen instructions.

  5. Complete the installation.

Once finished, the lock is linked to the door automatically.


After Installation

After installation:

  • Lock details appear in the Portal Dashboard

  • The Locks and Settings tabs become available for the door

  • Firmware, connectivity, and lock status are visible


How to Uninstall a Lock

Step 1: Open the Staff App

  1. Open the Portal Staff App.

  2. Log in using your Portal Dashboard credentials.

  3. Tap Doors at the bottom of the screen.


Step 2: Open Door Details

  1. Find the room name or number.

  2. Tap the door to open Door Details.

  3. Tap the three dots (⋮) in the top-right corner.

  4. Select Uninstall.


Step 3: Complete the Uninstall Process

  1. Stand close to the lock.

  2. Make sure Bluetooth is enabled.

  3. Touch the lock keypad to wake it up.

  4. Tap Uninstall in the app to confirm.

Wait until the process completes.


After Uninstalling the Lock

Once the uninstall process is complete:

  • The lock is removed from the door in Portal.

  • The door remains in the system unless deleted manually.


How to Delete the Door (Optional)

If the room should also be removed from Portal:

  1. Go back to the Doors list.

  2. Find the door name.

  3. Press and hold on it.

  4. Select Delete.

Permissions & Access

Role

Lock Installation Access

Owner

Full access

General Manager

Full access

Installer

Install and remove locks

Team

No installation access

Housekeeping

No installation access


Tips / Best Practices

  • Install locks close to the device

  • Verify battery power before installation

  • Select the correct device type

  • Complete installation in one session


Troubleshooting / FAQs

The lock does not appear during installation
Check battery power and stay within Bluetooth range.

Installation fails midway
Move closer to the lock and restart the process.

I can’t install locks
Verify your role includes installation permissions.

The uninstall button is not visible
You may not have sufficient permissions.

The uninstall fails midway
Wake the keypad again and ensure Bluetooth is enabled.


Related Articles

Did this answer your question?