Skip to content

Additional Lock Endpoints#

Update the name of a lock#

To update the name of a lock, you can use the following API call:

Required

You must be an owner of the lock to use this endpoint, otherwise the API will return an error.

PUT /locks/:lockID

x-august-api-key: <your API key>
x-august-access-token: <your partner user's access token>

{
    "LockName": "new-lock-name"
}

The following fields in the request parameters and request body are required:

  • lockID - The unique August/Yale identifier for the lock you want to update.
  • LockName - The new name you want to assign to the lock.

This will update the name of the lock with the specified lockID to the new name you provided. The API will respond with HTTP status 200 and a response body indicating the lock name was successfully updated.

{
  "message": "success"
}