AccessCodes

Create digital access codes for a booking

POST

/bookings/{id}/accesscode

Generates guest access codes on every smart lock configured on the booking's property, valid from the booking's arrival time until the departure time.

Create digital access codes for a booking › path Parameters

id

string · required

Booking id

Create digital access codes for a booking › Responses

Access codes created. failed_smartlocks lists any locks the provider rejected.

KeysResponse

accessCode

string · required

BookingAccessCode[] · required

SmartLockInfo[] · required

POST/bookings/{id}/accesscode

curl --request POST \
  --url /bookings/:id/accesscode

shell

Example Responses

{
  "accessCode": "accessCode",
  "accessCodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "vendor_code_id": "vendor_code_id",
      "code_start_datetime": "code_start_datetime",
      "code_end_datetime": "code_end_datetime",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "deleted_at": "deleted_at",
      "smartlock": {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name",
        "property_id": "00000000-0000-0000-0000-000000000000",
        "nuki_smartlock": {
          "id": "00000000-0000-0000-0000-000000000000",
          "nuki_smartlock_id": "nuki_smartlock_id"
        },
        "unifi_smartlock": {
          "floor_id": "floor_id",
          "door_id": "door_id",
          "name": "name",
          "assigned_property": {
            "property_id": "00000000-0000-0000-0000-000000000000",
            "property_name": "property_name",
            "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
          }
        },
        "lock_state": 0,
        "battery_level": 0,
        "battery_charging": true,
        "offline": true
      }
    }
  ],
  "failedSmartlocks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ]
}

json

application/json

Revoke a digital access code

DELETE

/accesscodes/{id}

Removes the access code from its underlying smart lock and deletes the record.

Revoke a digital access code › path Parameters

id

string · required

Access code id

Revoke a digital access code › Responses

Access code revoked

No data returned

Account

Kasify API

AccessCodes

Create digital access codes for a booking

POST

/bookings/{id}/accesscode

Generates guest access codes on every smart lock configured on the booking's property, valid from the booking's arrival time until the departure time.

Create digital access codes for a booking › path Parameters

id

string · required

Booking id

Create digital access codes for a booking › Responses

Access codes created. failed_smartlocks lists any locks the provider rejected.

KeysResponse

accessCode

string · required

BookingAccessCode[] · required

SmartLockInfo[] · required

POST/bookings/{id}/accesscode

curl --request POST \
  --url /bookings/:id/accesscode

shell

Example Responses

{
  "accessCode": "accessCode",
  "accessCodes": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "booking_id": "00000000-0000-0000-0000-000000000000",
      "smartlock_id": "00000000-0000-0000-0000-000000000000",
      "access_code": "access_code",
      "vendor_code_id": "vendor_code_id",
      "code_start_datetime": "code_start_datetime",
      "code_end_datetime": "code_end_datetime",
      "created_at": "created_at",
      "updated_at": "updated_at",
      "deleted_at": "deleted_at",
      "smartlock": {
        "id": "00000000-0000-0000-0000-000000000000",
        "vendor": "vendor",
        "name": "name",
        "property_id": "00000000-0000-0000-0000-000000000000",
        "nuki_smartlock": {
          "id": "00000000-0000-0000-0000-000000000000",
          "nuki_smartlock_id": "nuki_smartlock_id"
        },
        "unifi_smartlock": {
          "floor_id": "floor_id",
          "door_id": "door_id",
          "name": "name",
          "assigned_property": {
            "property_id": "00000000-0000-0000-0000-000000000000",
            "property_name": "property_name",
            "smartlock_record_id": "00000000-0000-0000-0000-000000000000"
          }
        },
        "lock_state": 0,
        "battery_level": 0,
        "battery_charging": true,
        "offline": true
      }
    }
  ],
  "failedSmartlocks": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "vendor": "vendor",
      "name": "name"
    }
  ]
}

json

application/json

Revoke a digital access code

DELETE

/accesscodes/{id}

Removes the access code from its underlying smart lock and deletes the record.

Revoke a digital access code › path Parameters

id

string · required

Access code id

Revoke a digital access code › Responses

Access code revoked

No data returned

Account