Create Access

post

https://www.keycafe.com/v0/access

Create an access with a POST request to the endpoint.

Body Params

user

object

The user being give access. Only the ID property is necessary if it's an existing user. Otherwise, an email address or mobile number can be included to invite a new user.

key

object

required

The key for which access is being given. Only one of the ID or serialNumber property is necessary.

accessStartDate

string

The access start date . See the discussion of date formats below.
Example: 2025-07-21

accessStartTime

string

The access start time . See the discussion of date formats below.
Example:12:45

accessEndDate

string

The access end date . See the discussion of date formats below.
Example: 2025-07-23

accessEndTime

string

The access end time. See the discussion of date formats below.
Example: 12:45

timeZone

string

The access time zone. See the discussion of date formats below.
Example: America/Vancouver

name

string

The visitor's name. Required if no user information is specified. In this case, because the user's contact information is not available, you will be responsible for communicating the booking code, booking URL, and instructions to your guest.
Example: Paul

returnReminder

boolean

Defaults to false

Default false. Whether the guest should be sent a reminder to return the key after their visit.
Example: False

suppressGuestNotifications

boolean

Defaults to false

Default false. If true, prevents any access notifications from being sent to the guest.
Example: False

locale

string

The locale to use to send notifications to the guest. Supported values are en, fr, ja, es, nl, it, pt.
Example: en

allowSetup

boolean

Defaults to false

Default false. If true, the access recipient will be able to attach a fob to the key.
Example: false

startDate

date

Deprecated. See the discussion of date formats below. The start date of the access, in ISO 8601 format without milliseconds. If both startDate and endDate are omitted, the access is considered ongoing.
Example: 2025-07-21T12:45:00Z

endDate

date

Deprecated. See the discussion of date formats below. The end date of the access, in ISO 8601 format without milliseconds. If both startDate and endDate are omitted, the access is considered ongoing.
Example: 2025-07-23T17:45:00Z

Response

200Access record successfully created.