Error Codes#

These are the errors you may get when calling API endpoints.

Remote Operate#

These are the errors you may get when calling the remote operate endpoint.

HTTP Error Code	Error Category	What likely happened?	User Message in August App
408	LOCK UNAVAILABLE	Some sort of timeout, usually a request was sent to Connect to send to the lock and the server didn’t receive a response in a timely manner. There might be multiple reasons behind this, one of them is if the lock stops functioning (for example no power at all)	Lock Unavailable
409	CONFLICT	In the case of `GET /locks/:lockID/status`, this indicates the lock has no bridge.
412	PRECONDITION FAILED	Check the error text for the exact precondition that failed, e.g. Lock does not have a bridge associated with it.
422	CONNECT UNAVAILABLE	Connect hasn’t connected to our services in a while (usually 3-5 minutes), means that the Connect is offline.	Connect Unavailable
423	BRIDGE IN USE	The bridge is currently communicating with the lock	Connect Unavailable
460	LOCK BUSY	The lock is busy talking over bluetooth to something else like a keypad or August App.
500	LOCK UNAVAILABLE	Some server error	Connect Unavailable
530	LOCK UNAVAILABLE	There was a mechanical timeout, usually indicates a jam	Lock Is Jammed
531	LOCK UNAVAILABLE	There was a problem detecting the mechanical position of the lock, either an uncalibrated lock or a jam.	Lock Calibration Failure
550	LOCK UNAVAILABLE	Low battery, usually will return when there isn’t enough power to either Lock or Unlock the door.	Low Battery Failure
551	LOCK UNAVAILABLE	High temperature	Lock Overheated Failure
560	LOCK UNAVAILABLE	Unexpected disconnect during communication: while processing a command (status/lock/unlock) the lock disconnected abruptly from Connect.	Lock Disconnected

PIN Management#

These are the errors you may get when calling the PIN management endpoint.

Note: You may also get remote operate errors when calling this endpoint.

PIN already exists#

The PIN already exists on the lock.

How to fix.

Use a different PIN.

HTTP Status Code	Error Name
409	ERRNO_ALREADY_EXISTS

Bad state#

The PIN is in a state in which desired action cannot be applied. It cannot transition into desired state from its current state.

HTTP Status Code	Error Name
409	ERRNO_BAD_STATE

Slot must be a number#

body.slot must be a parseable Number

HTTP Status Code	Error Name
409	ERRNO_SLOT_MUST_BE_NUMBER

Slot not reserved#

A slot was not reserved on the lock for the PIN.

How to fix.

Call the request valid PIN endpoint first.

HTTP Status Code	Error Name
409	ERRNO_SLOT_NOT_RESERVED

Slot out of range#

The PIN slot is outside of the supported range.

HTTP Status Code	Error Name
409	ERRNO_PIN_SLOT_OUT_OF_RANGE

Cannot use reset code#

The PIN cannot be set because it is the keypad's reset code.

How to fix.

Use a different PIN.

HTTP Status Code	Error Name
409	ERRNO_CANNOT_SET_RESET_CODE

Bad PIN format#

The PIN is too short, too long, or not-numeric characters.

How to fix.

Use a PIN that is between 4 and 6 numbers long.

HTTP Status Code	Error Name
409	ERRNO_BAD_PIN_FORMAT

Access type mismatch#

This error can occur when updating or deleting a PIN that is already on a lock. The access type you provided did not match the access type of the PIN.

How to fix.

Use the list lock PINs endpoint to get the correct access type of the PIN.

HTTP Status Code	Error Name
409	ERRNO_ACCESS_TYPE_MISMATCH

Access times mismatch#

This error can occur when updating or deleting a PIN that is already on a lock. The access times you provided did not match the access times of the PIN.

How to fix.

Use the list lock PINs endpoint to get the correct access times of the PIN.

HTTP Status Code	Error Name
409	ERRNO_ACCESS_TIMES_MISMATCH

Access recurrence mismatch#

This error can occur when updating or deleting a PIN that is already on a lock. The access recurrence you provided did not match the access recurrence of the PIN.

How to fix.

Use the list lock PINs endpoint to get the correct access recurrence of the PIN.

HTTP Status Code	Error Name
409	ERRNO_ACCESS_RECURRENCE_MISMATCH

Missing PIN#

No PIN was found in the HTTP request body.

How to fix.

Pass the pin property in the HTTP request body.

HTTP Status Code	Error Name
409	ERRNO_NEED_A_PIN

Invalid PIN slot user#

The user making the API call does not have permission to set the slot on the lock. For example:

The master PIN on slot-based locks can only be set by the 'master PIN' system user.

HTTP Status Code	Error Name
409	ERRNO_INVALID_PIN_SLOT_USER

Invalid PIN slot#

This error happens when the 'master PIN' system user tries to set a PIN that isn't the master PIN.

HTTP Status Code	Error Name
409	ERRNO_INVALID_PIN_SLOT

Master PIN not supported#

The lock does not support master PIN.

HTTP Status Code	Error Name
409	ERRNO_MASTER_PIN_NOT_SUPPORTED

No keypad#

The lock does not have a keypad.

HTTP Status Code	Error Name
409	ERRNO_LOCK_DOES_NOT_HAVE_KEYPAD

Access type incompatible#

The access type of the PIN is incompatible with the lock.

Some locks do not support one-time PINs.
The first generation August Smart Lock does not support temporary or recurring PINs.

How to fix.

Use a different access type.

HTTP Status Code	Error Name
409	ERRNO_ACCESS_TYPE_INCOMPATIBLE

Invalid PIN state and action#

The state must be load, delete, disable, enable, or update. The action must be intent or commit. This is an internal error.

HTTP Status Code	Error Name
409	ERRNO_INVALID_STATE_AND_ACTION

PIN not found#

We can't find the PIN. This error can occur when updating or deleting a PIN that is already on the lock.

How to fix.

Pass the pin property in the request body.
If you're already passing the pin property, we can't find that PIN on the lock. You should create a new one.

HTTP Status Code	Error Name
404	ERRNO_NO_PIN_GIVEN_OR_NOT_FOUND

All slots used#

The PIN could not be loaded because all slots on the lock are used.

How to fix.

Delete a PIN first.

HTTP Status Code	Error Name
409	ERRNO_ALL_SLOTS_USED

Lock Must be Upright#

You can get errors if your lock is not properly mounted. Most locks have a lot of sensors in them, including a sense of orientation. If the lock is not mounted on a door or other vertical surface then it can behave in unexpected ways.