Sign in

v1

latestOpenAPI 3.0.12026-08-06106119306.5 KB
/organizations/{organizationId}/bookings

Add, update or delete bookings

This endpoint isn't RESTful, it's intended to provide a simple way to add, update and delete invitations and permissions while keeping references to origin users, bookings and booked resources. This endpoint is a combination of the permission, invitation and identity mapping endpoints and most things that can be done with this endpoint, could also be done with the other endpoints. The KleverKey Zapier app uses this endpoint.

post/api/v1/organizations/{organizationId}/bookings/{serviceName}

Path parameters

organizationIdinteger required

Organization ID

serviceNamestring required

Service name (allowed characters are lower case a-z, 0-9 _ and -)

Request body

useLockActivationLinksboolean

Grants or revokes lock activation links (guest access) if true, else standard users with permissions/invitations will be used

userReferenceIdstring nullable

The user reference ID should be unique - it will be used to map a user when it's email address changes

userEmailstring nullable
userNamestring nullable

The user name should be a first name and last name if available - it will only be used for lock activation links (guest access)

preventSendingboolean nullable

Prevents sending of emails or text messages for lock activation links (guest access)

messagestring nullable

The message appears in emails and on the web page that gets displayed for lock activation links (guest access)

operationType1 | 2 required

1 = CreateOrUpdate, 2 = Delete

Response

OK