Operate Lock

Unlocks or locks a Lock in the given Project directly, without a Key. The operation is recorded as an access
event on the Lock with your API credentials as the actor, and the optional externalReference, so you can trace
each operation back to a user or action in your own system.

The response is returned once the lock vendor has confirmed the operation.

This endpoint requires the operateLockApi module to be active for the Project. Contact Unloc to have it
activated.

Required Scopeproject.admin
Required ModuleoperateLockApi
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.

string
required

ID of the Lock.

Body Params
string
enum
required

The operation to perform on the Lock.

Allowed:
string
length ≤ 255

A reference in your own system for this operation, e.g. the id of the user who requested it.

Responses

500

The lock vendor could not operate the Lock, e.g. because the Lock is offline.

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