How can we help? 👋

Escapia

Learn how to connect Akia to Escapia


Enabling Escapia Integration

  1. Request an Akia partner connection
    1. Navigate to the Escapia contact page (https://support.escapia.com/escapia/contact). For Step 1, select Setup. For Step 2, select Email.

      Notion image
       

      Fill in your account name and info and paste the following text into the correct field

       
      💬
      Subject: Partner Connection for Akia via HSAPI
       

      Text: Please connect the partner Akia via HSAPI to my account. My Akia Contact is: <name and email of your Customer Success Representative>

       

2. Enable Akia and set permissions

 

Once your request has been completed by HomeAway (24-48 hours), they will send you an email once it has been completed, log into your Escapia dashboard and add Akia as a partner, then give the necessary permissions.

 

Navigate to the HomeAway Partner Page:

Notion image
 

Locate Akia, and then click Manage Partner.

 
💡
If you are on a newer Escapia version, go into Escapia and navigate to Admin > Setup > EscapiaNET > Network Partners, click on "The Akia Syndicate" and distribute your units if you've not already done so; and continue with the following steps
 
Notion image
 

When the Edit Permissions page loads, select the Enabled checkbox at the top of the page.

  • Check Can Access Unit Addresses and Can Access Unit Door Codes at the top.
 
Notion image
 
  • Check the following methods access permissions:
    • SearchUnitSummaries
    • GetUnitByID
    • SearchReservationSummaries
    • GetReservationById
    • GetReservationByNumber
    • AddReservationEventByReservationNumber
    • ListMarketingCategories
    • ListReservationTypes
    • GetReservationChanges
Notion image
 
⚠️
Creating multiple bookings under one reservation is not recommended by Escapia, so Akia does not support this type of reservation. Escapia suggests that PMs manage multiple bookings and multiple reservations instead. Please reach out to Escapia support to help you prevent guests from creating multiple bookings under one reservation.
 
 

Installing Escapia in Akia

  1. Navigate to Akia’s integration page
  1. Find Escapia under the Property Management category
  1. Install the Escapia app to complete the setup
    1. Notion image
       

I Have New Units but the Akia Tokens Aren’t Working

Escapia updated their API late 2023, so if your property has added new units, you will have to follow the below steps to ensure Akia gets the following fields.

 
Category
Standard Field Name
Internet
Internet Access
Amenities
Pool
Amenities
Hot Tub
Amenities
Fireplace
Amenities
TV
Cleaning
Trash & Recycling
Access
Lockbox Instructions
Access
Garage Access
Access
Gate Instructions
Pre-Arrival
What to bring
Arrival
Parking
Arrival
Arrival Instructions
Departure
Departure Instructions
Other
Other Useful Information
Other
General Information
Other
Property Instructions
Other
Emergency Information
 

One Unit at a Time

  1. Under Units, open the individual unit then navigate to the Additional Fields tab
  1. Click into one of the Standard Fields and update the text so the save button becomes reenabled
  1. Save
  1. Following this save, the 17 fields will now write back into HSAPI so Akia can retrieve the data
 

All Units at Once (via Bulk Import)

  1. Navigate to Units > Setup > Additional Fields
  1. Download the spreadsheet containing all units and Standard Fields
  1. Reimport the same spreadsheet
  1. Once imported / saved, the 17 fields will now write back into HSAPI so Akia can retrieve the data
 

Escapia does NOT share the following fields in the API, Akia will not be able to get data in the following fields:

 
Category
Standard Field Name
Internet
Wifi Network
Internet
Wifi Password
Amenities
Firepit
Amenities
HVAC
Amenities
Kitchen Appliances
Amenities
Outdoor Grill
Cleaning
Laundry
Cleaning
Dishwasher
Cleaning
Towels & Linens
Access
Elevator
Access
Accessible Entrance
 

 

Integration Breakdown

  • Limited 2-way integration - Akia can mark the rental contract as signed in Escapia
  • Direct API - Akia receives new bookings with a brief delay (~45 min)
 

What Can I Do Now That I Have Escapia?

  • Reference unit custom fields in your Mini Apps - this information is automatically pulled from Escapia, no work on your end to manually copy it to Akia
    • For example, arrival, parking, departure, internet access instructions
 

Available Custom Message Tokens

Here are some examples of Escapia-only message tokens we get directly from your Escapia account. These can be used in your Mini Apps to better customize the information for the guest. Reach out to us in the Support Chat if what you’re looking for isn’t here:

 
Field Label
Token
Unit Image
customer.escapia_unit_image__c
Unit Headline
customer.escapia_unit_headline__c
Unit Summary
customer.escapia_unit_summary__c
Unit Description
customer.escapia_web_description__c
Lock Box Code
customer.escapia_lock_box_code__c
Key Code
customer.escapia_key_code__c
Pet Friendly
customer.escapia_pet_friendly__c
What to Bring
customer.escapia_what_to_bring__c
Access Instructions
customer.escapia_access_instructions__c
Departure Instructions
customer.escapia_departure_instructions__c
Parking Instructions
customer.escapia_parking_instructions__c
Arrival Instructions
customer.escapia_arrival_instructions__c
Internet Access Instructions
customer.escapia_internet_access_instructions__c
Property Instructions
customer.escapia_property_instructions__c
Garage Access Instructions
customer.escapia_garage_access_instructions__c
Pool Instructions
customer.escapia_pool_instructions__c
Driving Directions
customer.escapia_driving_directions__c
Trash Instructions
customer.escapia_trash_instructions__c
TV Instructions
customer.escapia_tv_instructions__c
 
Did this answer your question?
😞
😐
🤩