API Reference
API ReferenceGuides

Create a new Doorbell

post
https://api.unloc.app/v2/projects//doorbells

Creates a new Doorbell.

Users added to the Doorbell user list will also be added as Managed Users to the project if they are not already a part of the project.

Required Scopeproject.admin
Required Moduledoorbell
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Project. Must match the one in the JWT.

Body Params
string
required
length between 5 and 256

The name of this Doorbell. Will be displayed in the Doorbell app.

string
required

The unique id of the Lock that this Doorbell is connected to. It must be a Lock that belongs to the same Project as the Doorbell. Note: Only Locks connected to the internet are supported for now. Contact Unloc for a an updated list of supported Lock types.

doorbellUserLists
array of objects
required

A list of of DoorbellUserLists that should belong to this Doorbell. Currently, only one DoorbellUserList is supported and displayed in the Doorbell app. Providing more than one DoorbellUserList will result in an error until more is supported.

doorbellUserLists*
string
length ≤ 2048

Instructions for the user to follow when they ring the Doorbell. Will be displayed in the Doorbell app when a user is let in.

uuid

The unique id of the sticker that is attached to the Doorbell. This is used to link a sticker to a Doorbell, and let's users scan a sticker to start the Doorbell app.

Responses

Updated about 1 month ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago