API Reference
API ReferenceGuides

Update a Lock

patch
https://api.unloc.app/v2/projects//locks/

Updates a Lock's information.

Use null to delete data from fields. This will work for the base64ImageData, note and address field. Non-required fields in address, such as floor or visitorInstructions can also be deleted in this way.

Required Scopeproject.admin
Path Params
string
required

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

string
required

ID of the Lock.

Body Params
string

New name for the Lock.

string | null

New Lock image data. Must be given as a base64 encoded string. Maximum 10MB.

address
object | null

Object containing address data.

string

Timezone in tz database format (Area/Location_Name). A full list of timezones can be found here.

location
object

A Geolocation describing a position with latitude and longitude.

string | null

A custom note about the Lock.

string
enum

The privacy policy for KeyEvents on this lock. Read more about privacy policies in the Privacy Policy guide.

Allowed:
Responses

Updated 7 months ago

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