API Reference
Start typing to search…

Create Key

post
https://www.keycafe.com/v0/key

Create a key with a POST request to the endpoint.

Body Params
string
required

The key name.
Example: Bob's Home Key

string

The key description. The maximum length is 60 characters.
Example: The front door key

string

The serial number of the fob attached to the key. If omitted, it will be collected during the key's first drop off.
Example: 012ABC

string

The internal notes. These will not be displayed to the guest. The maximum length is 100 characters.
Example: The cleaners come every Monday at 10:00

string

A note to send to the guest after a pickup. The maximum length is 240 characters.
Example: Don't mind the dog. He's harmless.

address
object

A nested object containing the location address.

homeLocation
object

The location where the key is expected to be dropped off. This is used to communicate to a user where they should drop the key off, and should not be confused with the currentLocation property, which is read-only and can only be modified by a drop off. A drop off will also update the key's home location to the most recent drop off location, and this property may only be set while the key is checked out. Only the ID property is necessary to set a home location.

boolean
Defaults to false

True if the key should be virtual and allow key codes.

string

A 4 to 16 digit numeric code which allows instant pickups for virtual keys when the code is entered locally at the Keycafe SmartBox. If the parameter is omitted for the virtual key, the code will be generated automatically.

organization
object

If provided, the key will be created under the specified organization. If omitted, the key will default to the first organization created for the user.

boolean

Determines if the key can be dropped off at any location (true) or only at its home location (false). Applies only to MS4 and newer devices.

Response

Updated 8 months ago

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