Excluded Devices

There may be a case where you want to exclude a Yale/August device from third party management. For example, if you are a property manager and have a subset of your available devices that do not need to be managed or billed for but were connected because all of a user's devices were under one single account.

Here are a few handy API endpoints that you may use to manage devices that you would like excluded from third party management, app use, and billing.

Required

A partner who wishes to use these features must have the partners:excluded_lock_mgmt permission associated with their account to successfully use these endpoints.

Add An Excluded Lock

POST /partners/excludedlocks/:lockID

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

This will add a lock your list of excluded devices. You will then have this lock excluded from third party management, app use, and billing. You must be an owner of the lock to use this endpoint.

The API will respond with HTTP status 200 and a response body indicating the excluded lock was successfully added.

{
  "message": "success"
}

Remove An Excluded Lock

DELETE /partners/excludedlocks/:lockID

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

This will remove a lock from your list of excluded devices. This lock will then be available to be managed by you and will be subject to partner billing charges. You must be an owner of the lock to use this endpoint.

The API will respond with HTTP status 200 and a response body indicating the excluded lock was successfully removed.

{
  "message": "success"
}

Get A List Of All Excluded Locks

GET /partners/excludedlocks/mine

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

This will return a list of all of your excluded devices.

The API will respond with HTTP status 200 and a response body containing all Lock IDs associated with your excluded locks.

{
  "lockIDs": [
    "0000LOCKID10000",
    "0000LOCKID20000"
  ]
}