Rently Tour

Stage 1 – property data sync into Rently

In this stage, our goal is to get properties from your marketing CRM into Rently database. With this step, we eliminate manual data input and always keep property data up to date. There are two options to provide property data sync. 1) sync through RentCafe,Appfolio,Propertyware, etc ILS settings, up side is it works without coding, but down side is need to check ILS setting for each individual properties. 2) sync through Rently JSON file format, up side is centralized control from CRM, but down side is there is development cost from your IT team. For further interest in option 2, please refer to the document called “Rently Data Pull Format”

Stage 2 – marketing integration

In stage 2, we want to maximize our marketing exposure and shorten the interest to viewing time for your properties. There are two components to this process, your website and ILS syndication. For your website, we can provide either a property list display or property specific self-touring instructions. For property specific touring instructions, please refer to document called “Rently Self Tour Embed”.  For your ILS syndication, we recommend that you create an auto email responder to let renter know about your self viewing option.

Stage 3 – leasing activities integration

In stage 3, the goal is to focus on reporting and tracking. There are two types of integration. Real time notification and historical record in take. Real time notification is a webhook that post to your HTTP endpoint in real time when an event occurs. Essentially all emails that you receive, you can get a webhook as well. Refer to “Rently Activities Notification via Webhook”.  Historical record is provided via csv format. You can manual trigger a report in account -> data export. We can also setup an auto data export hourly. The export fields are described in “Rently Report Data Dictionary”

Rently will process data pull on hourly basis. Properties on the feed will be added or updated in Rently system. Properties not on the feed will be inactivated in Rently system.

The file format is JSON with following fields: (* fields are required)

• heading – short marketing title
• tag* – primary id internal to your system
• type – type of property.
  • 1 – Single Family House
  • 2 – Town Home
  • 3 – Apartment
  • 4 – Single Room
  • 5 – Condo
  • 6 – Commercial
• address* – full address of the property
• rent*- rental price
• deposit – rental deposit
• bedrooms* – number of bedrooms (decimal allowed)
• bathrooms* – number of baths (decimal allowed)
• pets – Yes/True/OK/Allow if allow pets, otherwise forbid pets
• size – size in sq ft
• description – full property marketing text
• images – Array of strings based URL for property photos. First link will be used as profile picture
• lockbox* – Rently lockbox serial number installed on door. If you don’t know the lockbox number, you can use the string ‘ignore’

# ‘ignore’ means skip lockbox and active fields
# ‘defaultPrelease’  makes newly pulled property default to prelease instead of inactive
# ‘000000’ makes properties appear as Listing Only / Inactive
# ‘unassign’ makes current lockbox/hub unassigned from property

 

• lockbox_instruction* – where to locate lockbox on property
• market_id – if you have multiple account with Rently, specify the name of the account this property should be assigned
• prelease – set this field to true will enable prelease mode
  active* – if property auto showing ready – true / false (if active is false, prelease field will be ignored)

# active = true, prelease = false -> auto showing
# active = true, prelease = true ->  waitlist
# active = false                         ->  off market

 

• agent_email – email address of the agent that is in charge of this property. The corresponding agent in Rently will be associated with this property automatically.
• application_url – the url that will be associated with ‘Apply Now’ button.
• available_date – rent ready date for a property.
• video_url – video url for this property
• amenities – amenities provided for this property.  When amenities case ignore match with existing Rently portal amenities checkbox, will check the box; otherwise will show in additional amenities textbox session.

Format like {“amenities” : [“deck”, “microwave”, “water”, “My Amenity” ]}

Below are existing amenities types:

– Property amenities:
“Barbecue Area”, “Basement”, “BasketBall Court”, “Business Center”, “Cable Satellite”, “Child Care”, “Club Discount”, “Concierge”, “Controlled Access”, “Courtyard”, “Deck”, “Disabled Access”, “Dock”, “Doorman”, “Elevator”, “Fenced Yard”, “Fitness Center”, “Garden”, “Gated Entry”, “Green House”, “Hot Tub Spa”, “House Keeping”, “Intercom”, “Jetted Bath Tub”, “Lawn”, “Night Patrol”, “OnSite Maintenance”, “OnSite Management”, “Package Receiving”, “PlayGround”, “Pond”, “Pool”, “Porch”, “RaquetBall Court”, “Sauna”, “Security System”, “Skylight”, “Sports Court”, “Sprinkler System”, “Sun Deck”, “Tennis Court”, “TV Lounge”, “VolleyBall Court”, “Wet Bar”
– Model amenities:
“Dishwasher”, “Washer”, “Dryer”, “Freezer”, “Garbage Disposal”, “Microwave”, “Range Oven”, “Refrigerator”, “Trash Compactor”, “Fireplace”, “Ceiling Fan”, “Double Pane Windows”, “Handrails”, “Large Closets”, “Mother In Law Unit”, “Patio”, “Balcony”, “Storage Space”, “Vaulted Ceiling”, “Window Coverings”
– Rent includes:
“Water”, “Sewage”, “Garbage”, “Electricity”, “Gas”, “Internet”, “Cable”, “Sat Tv”, “A/C”, “Hot Water”
– Parking type:
“Carport”, “Garage Attached”, “Garage Detached”, “Off Street”, “On Street”

Example file:

[

    {

        “tag”: 123,

        “heading”: “Fantastic newly Renovated 2bd/2ba home Must move in by June 30 *1/2 Month FREE  “,

“type”: 1,

        “address”: “3450 Kingswood St, Thousand Oaks, 91362”,
        “rent”: 875,

        “deposit”: 2000,

        “bedrooms”: 2,

        “bathrooms”: 2,

        “pets”: “Yes”,

        “size”: 1426,

        “description”: “Cute home just south of Atlanta with spacious rooms and huge yard and hardwood floors!”,

        “images”: [

            “https://d2za1aptzht3l1.cloudfront.net/assets/logo-551ea1ae3d34727908abb39e4b500460.png”

        ],

        “lockbox”: “123456”,

        “lockbox_instruction”: null,

        “market_id”: “Columbia”,

        “prelease”: false,

        “active”: true,

        “agent_email”: “json@email.com”,

        “application_url”: “https://applynow/id/12345 “,

        “available_date”: {

          “year”: 2019,

          “month”: 7,

          “day”: 9

        },

“video_url” : “https://test_video_url “,

“amenities” : [“deck”, “microwave”, “water”, “My Amenity” ]

    }

]

Rently’s website:

Iframe Option – The iframe option displays the schedule button within your site. Has a more stream lined look.

Example : https://u2.rently.com/propertiesSearch2

Popup Option – The schedule page can be configured as a popup. This is easier to implement, and it is the most common scenario for rental site integration.

 Example: https://secure.rently.com/properties/schedule_embed?uid=2&name=21438

Mobile Device View – Mobile devices are automatically detected, and a mobile friendly registration is shown.

 

ILS – Trulia Zillow Hotpad – Listings are automatically syndicated to these sites. When renter’s inquires through anyone of these platform. We will email them about the viewing details.

A URL provides integration to the Rently Self Tour registration page and client’s Self Tour button. The content is displayed in a special embed mode without normal Rently logo and menu.

Responsive Design

The responsibility of displaying content from URL is on the client’s web site. As a good responsive design practice, the recommendation is to display the content inside a HTML modal window on PC, and to display content in new window on mobile/tablet.

URL Endpoint:

/properties/schedule_embed for embedded mode

/properties/schedule_popup for popup mode

 Example: https://secure.rently.com/properties/schedule_embed?uid=2&name=3174526

Parameters:

• • uid – the account id of the main corporate account
  • name – your internal id of the property in your CRM system. If name parameter is not matched, a blank page will be displayed
  • visitor_first_name – pre-populate renter’s first name in the rently forms to void duplicate form entry. optional field
  • visitor_last_name – pre-populate renter’s last name in the rently forms to void duplicate form entry. optional field
  • visitor_phone – pre-populate renter’s phone number in the rently forms to void duplicate form entry. optional field
  • visitor_email – pre-populate renter’s email in the rently forms to void duplicate form entry. optional field
  • utm_source – Utm campaign params (passed back to progress via webhook)
  • utm_content – Utm campaign params (passed back to progress via webhook)
  • utm_campaign – Utm campaign params (passed back to progress via webhook)
  • utm_term – Utm campaign params (passed back to progress via webhook)
  • utm_medium – Utm campaign params (passed back to progress via webhook)

Summary 

The registration API is intended to eliminate double data entry between Rently system and client’s own CRM. All data entry fields will be passed in via URL parameters, and API will display credit card screen if one is required. Once the interaction is complete, registration page will display the status message on screen and pass the status in JSON format back to calling page. 

Due to the need to display HTML content, this API is designed as HTML page that is inserted as an iFrame popup. This is not like a REST based API that one would typically expect. 

End Point 

https://secure.rently.com/prospects/registration 

URL Parameters 

property_tag: (required) The property ID in client’s CRM system 

full_name: full name of the prospect 

mobile_phone: (required) mobile phone used to register a prospect for self showing 

sms_notes: (limit 150 characters) the additional sms message that gets sent if the registration is successful. 

auth_token: use the auth token provided by Rently to process auto login 

require_cc: determine if credit card should be required. If require cc is true, but cc is already provided, then no cc is required 

Result 

status: return the result of the registration page. It could be one of the following values 

-banned: if a prospect is banned 

– incomplete: if property was not found, or if some required fields are not provide, or if credit card page is not complete 

– invited: if a prospect is successfully registered for open house 

– prelease: if a prospect is successfully registered for prelease wait list 

message: detailed response message in readable format 

Post Message 

In order to pass the registration result back to the calling page, we will use parent.postMessage function. https://developer.mozilla.org/en-US/docs/Web/API/Window/postMessage 

When the API sends postMessage function, a message event is triggered on the calling page (the CRM page). For example: 

window.addEventListener(“message”, receiveMessage, false); 

function receiveMessage(event) 

{ 

var result = JSON.parse(event.data;) 

// … 

} 

Usage

Rently reports contains transactional information on showings, leads, properties, and other Rently business data objects. Reports can be generated in two ways, via user interface and via URL generated by background job processor.

Background job processor

Once requested, we will provide a custom URL prefix that contains exports of your data. The files are updated every day and contains data for the prior 7 days. We recommend pulling each file every hour and match on IDs to update corresponding records in your data repository. Prior 7 days are included in export to allow the data exchange to catch up in case of temporary sync failure. For data sync failure that last more than 7 days, you may manually export data file from user interface and directly load into your data repository.

Following list provides unique URLs to access your export files.

Lead Activities	{URL prefix}/lead_activities.csv
Leads	{URL prefix}/leads.csv
Properties	{URL prefix}/properties.csv
Lockboxes	{URL prefix}/lockboxes.csv
Vendor Access Log	{URL prefix}/vendor_access.csv
Post Viewing Survey	{URL prefix}/survey_feedback.csv
ILS inquiries	{URL prefix}/email_inqueries.csv
Phone inquiries	{URL prefix}/phone_inqueries.csv
Tenant Access(only accessible for certain users)	{URL prefix}/tenant_access.csv
Agent Showing Summary(only accessible on Manager Portal)	{URL prefix}/agent_showing_summary.csv
Properties Summary view(only accessible on Manager Portal)	{URL prefix}/properties_summary_view.csv
Properties Summary view(only accessible on Manager Portal)	{URL prefix}/properties_summary_view.csv
Active Agents List(only accessible on Manager Portal by admin and super admin)	{URL prefix}/active_agents.csv
Agent Login Logs up to 90 days(only accessible on Manager Portal by admin and super admin)	{URL prefix}/login_audit.csv

New fields in files

Rently plans and adds fields to export file in order to respond to product design requirements. When new fields are added, they will be appended at the end of each row. No fields will be modified or deleted from export. Please keep the design in mind as you are implementing file import function.

Field Name	Data Type	Limits	Description
Id	Integer	Max value 2147483627	This is an internal serial number assigned for each activity.
activity_created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Date and time this activity was created
access	String/Varchar	Max 255 Characters	Type of record Value Description Controlled showing renter viewing record created by calling your leasing agent directly self_registered_scheduling renter registered online and indicated that they plan to view the target property self_registered_viewing actual renter viewing record. a renter may view a property without prior scheduling callcenter_showing renter viewing facilitated by rently Status when a status field is updated in lead detail page agent_assign when a lead is assign to an agent waitlist_alert when a lead receives alert of property back on market prelease_signup when a lead signs up a prelease property wait list agent_scheduling when a lead scheduled a showing with agent agent_viewing when a lead receives a showing with agent custom_prescreening_ban when a lead banned by prescreening questions property_apply when a lead applies a property
property_id	Integer	Max value 2147483627	Rently internal property ID.  Same Id as property export.
Name	String/Varchar	Max 255 Characters	Name that is entered in when prospects are registered
Phone	Integer	10 digits	Phone number used for registration
Email	String/Varchar	Max 255 Characters	Email that is entered during registration
agent_name	String/Varchar	Max 255 Characters	Agent name is here if this is an agent assigned viewing or scheduling
credit_card	0	0	Is the credit card on file: True or false
lead_id	Integer	Max value 2147483627	unique ID for lead
lead_created_date	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date this lead was first entered into Rently system
lead_status	String/Varchar	Max 255 Characters	Status field on lead detail page
account	String/Varchar	Max 255 Characters	Market name. Useful if when you are viewing report for multiple tabs.
source	String/Varchar	Max 255 Characters	The channel that initiated the auto showing. Sources could be PC or smartphone or qrcode
total_viewings	Integer	Max value 2147483627	Per prospect, how many propertied they have gained access to for this account
address	String/Varchar	Max 255 Characters	address of the property if it is a viewing activity
tag	String/Varchar	Max 255 Characters	Primary ID field in edit/add property
rating	Integer	0	renter rating on the viewing (1 to 5 points), if a view survey is completed
feedback	String/Varchar	Max 255 Characters	renter feedback on the viewing, if a view survey is completed
pcode	String/Varchar	Max 255 Characters	Property pcode used in Yardi system.
is_viewing	Boolean	True/False	Whether the activity is a visit to a property or not.
account_id	String/Varchar	Max 255 Characters	Account id to which property belongs to.
time_zone	String/Varchar	Max 255 Characters	Time zone of the property
ip_address	String/Varchar	Max 255 Characters	The public IP address of the prospect is granted a viewing code for a self viewing. This field is only populated for “self_registered_viewing” and “failed_viewing” access types

Field Name	Data Type	Limits	Description
Id	Integer	Max value 2147483627	This is an internal serial number assigned for each lead.
fullname	String/Varchar	Max 255 Characters	Full name of the lead
status	String/Varchar	Max 255 Characters	Status field on lead detail page
phone	String/Varchar	Max 255 Characters	phone number on lead detail page
email	String/Varchar	Max 255 Characters	email on lead detail page
assigned_agent	String/Varchar	Max 255 Characters	Agent field on lead detail page
credit card	Boolean	True/False	on file True or False
lead_created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date this prospect was first entered into Rently system
comments	String/Varchar	Max 255 Characters	comments entered into the leads detail page
account	String/Varchar	Max 255 Characters	market name (Charlotte, Pheonix, etc)
updated_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	when the lead was updated

 

Field Name	Data Type	Limits	Description
Id	Integer	Max value 2147483627	This is an internal serial number assigned for each property
Lockbox	String/Varchar	Max 255 Characters	serial number
showing_hour_name	String/Varchar	Max 255 Characters	The primary showing hour name based on agent showing
Address	String/Varchar	Max 255 Characters	address entered into Rently
summary	String/Varchar	Max 255 Characters	description of property
headline	String/Varchar	Max 255 Characters	headline on ad
description	0	0	Main marketing text
price	Float	1E-307 to 1E+308	Latest rental price of property
previous_rent	Float	1E-307 to 1E+308	Previous rental price of property
rent_updated_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date latest rental price is entered
status_title	String/Varchar	Max 255 Characters	Type of showing that is enabled for this property.
created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Date property record is created on Rently
active	Boolean	True/False	True means auto showing is active / false means auto showing is off
previous_lockbox	String/Varchar	Max 255 Characters	last lockbox assigned to this property if any
rent_ready_date	Date	N/A	this date is assigned when adding a property by the assigning of a lockbox to property section (yellow area)
lb_unassign_date	Date	N/A	this is when a lockbox is unassigned from a property
inactive_date	Date	N/A	this is when a property is marked inactive for automated showings
archive_date	Date	N/A	when it was archived
unit#	String/Varchar	Max 255 Characters	Primary ID field in edit/add property
stardard_address	String/Varchar	Max 255 Characters	Rently address system tries to standardize display format of the input address. It is used for geo-location display purpose
URL	String/Varchar	Max 255 Characters	Url that links to this property from browser
assigned_agents	0	0	Number of agents assigned to property from property alert section.
lb_assigned_date	Date	N/A	Records the date lockbox is assigned to property. Will not be updated when lockbox is assigned second time.
autoshowing_date	Date	N/A	Records the date property is first set to corresponding status. Will not be set when property enters this status second time.
agentshowing_date	Date	N/A	Records the date property is first set to corresponding status. Will not be set when property enters this status second time.
prelease_date	Date	N/A	Records the date property is first set to corresponding status. Will not be set when property enters this status second time.
agent_inactivate_date	Date	N/A	Records the date property is set to corresponding status the last time. Will  be updated each time this status is set.
total_showings	Integer	Max value 2147483627	Total number of showing.
current_week_showings	Integer	Max value 2147483627	Total showing in current week.
prelease_preshow_signups	Integer	Max value 2147483627	Total No of showing scheduled for future dates.
Statistic fields: total_calls            current_week_calls            total_inquiries            current_week_inquiries            last_7_days_leads            last_8_to_14_days_leads            last_15_to_30_days_leads            greater_than_30_days_leads        last_7_days_showings            last_8_to_14_days_showings            last_15_to_30_days_showings            greater_than_30_days_showings  interested            claimed_leads            unclaimed_leads	String/Varchar	Max 255 Characters	Shows corresponding property statistics. Data is updated nightly. total_calls, total_inquiries,interested, claimed_leads and unclaimed_leads will show for the past 30 days
tenant_name	String/Varchar	Max 255 Characters	Tenant’s Name.
tenant_phone	String/Varchar	Max 255 Characters	10 digit phone number(formatted/unformatted with/without country code).
access_start_date	Date	N/A	Date when access is provided.
access_end_date	Date	N/A	Date till when access should be available.
move_in_move_out_type	String/Varchar	Max 255 Characters	Type of access (move_in/move_out).
hub	Integer	Max value 2147483627	Hub id in Rently system(if attached).
pcode	String/Varchar	Max 255 Characters	Yardi Pcode(if available)
manager_app_access_allowed	String/Varchar	Max 255 Characters	Whether lock/lockbox can be accessible through code/app (TRUE/FALSE)
manager_app_access_blocked_reason	String/Varchar	Max 255 Characters	Reason if lock/lockbox cannot be accessible through code/app
secondary_external_id	String/Varchar	Max 255 Characters	Secondary External id used for sending guestcard for SFH
company_name	Integer	Max value 2147483627	This is the Company name the property belongs to.

Field Name	Data Type	Limits	Description
Address	String/Varchar	Max 255 Characters	Address of property
Name	String/Varchar	Max 255 Characters	CRM ID of the property in external system
Rating	0	0	Rating of property
Apply	String/Varchar	Max 255 Characters	Is prospect interested in applying
Improvement	String/Varchar	Max 255 Characters	Suggested improvement to the property
Notes	String/Varchar	Max 255 Characters	Additional feedback notes
Survey_feedback	String/Varchar	Max 255 Characters	Answer to additional survey questions defined by the company
created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	when the survey was first answered
updated_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	when the survey answer was updated
Lead_activity_id	Integer	Max value 2147483627	ID of showing event related to the survey
interest2	String/Varchar	Max 255 Characters	Is prospect interested in applying
access_problem	String/Varchar	Max 255 Characters	Was there a difficulty in accessing property? Was the key missing?
property_problem	String/Varchar	Max 255 Characters	Any issues with the property?
good_arrive	0	0	Deprecated Field
good_leave	0	0	Deprecated Field

Field Name	Data Type	Limits	Description
lockbox	String/Varchar	Max 255 Characters	Serial number of the lockbox
address	String/Varchar	Max 255 Characters	Property address of the lockbox
unit#	Integer	Max value 2147483627	Primary ID field in edit/add property
account	String/Varchar	Max 255 Characters	Manager account name
memo	String/Varchar	Max 255 Characters	memo of lockbox
last_activity	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Date of last activity
created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The timestamp the lockbox created
updated_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The timestamp the lockbox updated
assigned_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Timestamp lockbox assigned to the property manager
manager_id	Integer	Max value 2147483627	Account id to which lockbox allocated.
last_unshackle_agent	String/Varchar	Max 255 Characters	Who Unshackled for last time.
extended_codes	Boolean	True/False	Whether lockbox has extended codes enabled or not
is_lockbox	Boolean	True/False	Whether is a lockbox or not

Field Name	Data Type	Limits	Description
id	Integer	Max value 2147483627	Email Inquiries id
property id	Integer	Max value 2147483627	property id in Rently system
address	String/Varchar	Max 255 Characters	address of the property
name	String/Varchar	Max 255 Characters	unit tag of the property
record date	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	the timestamp of email inquiry
visitor name	String/Varchar	Max 255 Characters	email of the visitor
source	String/Varchar	Max 255 Characters	source of email inquiries
visitor full name	String/Varchar	Max 255 Characters	full name of the visitor
visitor phone	String/Varchar	10 digit phone number(formatted/unformatted with/without country code), it may contain “restricted” if its a private number	phone number of the visitor

 

Field Name	Data Type	Limits	Description
id	Integer	Max value 2147483627	Phone Inquiries id
property id	Integer	Max value 2147483627	property id in Rently system
address	String/Varchar	Max 255 Characters	address of the property
name	String/Varchar	Max 255 Characters	unit tag of the property
record date	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	the timestamp of phone inquiry
visitor phone	String/Varchar	10 digit phone number(formatted/unformatted with/without country code), it may contain “restricted” if its a private number	phone number of the visitor

 

Field Name	Data Type	Limits	Description
id	Integer	Max value 2147483627	Vendor access id
name	String/Varchar	Max 255 Characters	Vendor name
Call in date	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Date of call in
Phone	String/Varchar	10 digit phone number(formatted/unformatted with/without country code), it may contain “restricted” if its a private number	Call in number
Property	String/Varchar	Max 255 Characters	Address of the property
Lockbox	String/Varchar	Max 255 Characters	Action Taken by lockbox
Unit#	String/Varchar	Max 255 Characters	Unit tag of the property
Access Type	String/Varchar	Max 255 Characters	Whether this access is for a Vendor or Employee

 

Field Name	Data Type	Limits	Description
property_id	Integer	Max value 2147483627	This is an internal serial number assigned for each property
Address	String/Varchar	Max 255 Characters	address entered into Rently
unit#	String/Varchar	Max 255 Characters	Primary ID field in edit/add property(CRM_tag)
record-date	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	when the checkin/visit record is created.
visitor_phone	String/Varchar	10 digit phone number(formatted/unformatted with/without country code), it may contain “restricted” if its a private number	Tenant phone number
tenant_name	String/Varchar	Max 255 Characters	Tenant name
access_type	String/Varchar	Max 255 Characters	What type of access was provided(move_in/move_out)

 

Field Name	Data Type	Limits	Description
property_id	Integer	Max value 2147483627	This is an internal serial number assigned for each property
property_address	String/Varchar	Max 255 Characters	Property address
agent_name	String/Varchar	Max 255 Characters	Name of the agent assigned to the showing
primary_showing_hour_name	String/Varchar	Max 255 Characters	The primary showing hour name based on agent showing
agent_showing_status	Boolean	True/False	true if agent showing is enabled for the property and false if agent showing is disabled for the property
total	Integer	Max value 2147483627	Total number of agent showings, including canceled agent showings, that the assigned agent had for the property
no_show	Integer	Max value 2147483627	Total number of canceled agent showings that the assigned agent had for the property
unclaimed	Integer	Max value 2147483627	Total number of requested agent showings for the property that were not claimed by an agent
last_7_days_showings	Integer	Max value 2147483627	Total number of non-canceled agent showings that the assigned agent had for the property in the last 7 days
last_8_14_days_showings	Integer	Max value 2147483627	Total number of non-canceled agent showings that the assigned agent had for the property in the last 8 to 14 days
last_15_30_days_showings	Integer	Max value 2147483627	Total number of non-canceled agent showings that the assigned agent had for the property in the last 15 to 30 days
gt_30_days_showings	Integer	Max value 2147483627	Total number of non-canceled agent showings that the assigned agent had for the property more than 30 days ago
upcoming_showings	Integer	Max value 2147483627	Total number of non-canceled agent showings for the property that the assigned agent has scheduled in the future

 

Field Name	Data Type	Limits	Description
id	Integer	Max value 2147483627	This is an internal serial number assigned for each property
address	String/Varchar	Max 255 Characters	address entered into Rently
lockbox	String/Varchar	Max 255 Characters	lockbox serial number
showing_hour_name	String/Varchar	Max 255 Characters	The primary showing hour name based on agent showing
price	Float	1E-307 to 1E+308	Latest rental price of property
previous_rent	Float	1E-307 to 1E+308	Previous rental price of property
rent_updated_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date latest rental price is entered
status_title	String/Varchar	Max 255 Characters	Type of showing that is enabled for this property.
created_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	Date property record is created on Rently
lockbox_assigned_date prelease_date autoshowing_date agentshowing_date inactive_date agent_inactive_date	Date	N/A	Records the date property is first set to corresponding status. Will not be set when property enters this status second time.
ready_date	Date	N/A	This date is assigned when adding a property by the assigning of a lockbox to property section
last_7_days_leads last_8_to_14_days_leads last_15_to_30_days_leads greater_than_30_days_leads claimed_leads unclaimed_leads interested last_7_days_showings last_8_to_14_days_showings last_15_to_30_days_showings greater_than_30_days_showings upcoming_showings	String/Varchar	Max 255 Characters	Shows corresponding property statistics. Data is updated nightly.
secondary_external_id	String/Varchar	Max 255 Characters	Secondary external id used for sending guestcard for SFH

Field Name	Data Type	Limits	Description
fullname	String/Varchar	Max 255 Characters	Full name of the Agent
email	String/Varchar	Max 255 Characters	Email of the Agent
voice_phone	String/Varchar	Max 255 Characters	Phone number of the Agent
last_sign_in_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date this Agent was last entered into Rently system
role	String/Varchar	Max 255 Characters	The role of the Agent (eg- admin, data_entry, etc)
market	String/Varchar	Max 255 Characters	Market name (Charlotte, Pheonix, etc)

 

Field Name	Data Type	Limits	Description
fullname	String/Varchar	Max 255 Characters	Full name of the Agent
email	String/Varchar	Max 255 Characters	Email of the Agent
login_at	DateTime with zone (eg- 2019-01-08 22:12:05 -0800)	N/A	The date this Agent was entered into Rently system
ip	String/Varchar	Max 255 Characters	The ip from this Agent was entered into Rently system

Here is an example webhook post:

Content-Type: application/json

{“type”:”Self Registered Viewing”,”property_id”:16890,”address”:”2631 Miller Place, Thousand Oaks, CA”,”summary”:”4BD | 3BA | $3,000 /mo”,”checkin_at”:”05/13/2014 at 05:03AM”,”checkin_at_iso”:”2014-05-03T05:03:00-07:00″,”prospect_name”:”clark li”,”prospect_phone”:”8057096002“,“email”: “test@rently.com”,”property_tag”:””,”source”:”smartphone”}

The webhook fields include:

• type – event type possible values are

• • Prospect related webhooks:
    • Direct Code Showing – When direct code is requested for showing
    • Open House Scheduling – When open house showing is scheduled
    • Open House Viewing – When open house access code is requested for viewing
    • Self Scheduling – When a prospect schedule a future auto showing
    • Self Registered Viewing – When an auto showing code was requested
    • OTV Auto Showing – When an OTV link is sent for auto showing
    • Customer Care Direct Code – When access code is requested from Customer Care
    • Now Available – When a property becomes available for showing
    • Safe Mode – When a prospect requested showing on a  safe-mode-enabled property
    • Prospect Comment – Prospect comments after viewing
    • Pre Leased Lead Signup – When a prospect join in wait list for a preleased property
      
    • inquiry – ILS inquiry
  • Trusted visitor related webhooks:
    • Visitor Unlock – When access code fetched through manager portal
    • Visitor Unshackle – When unshackle code is fetched through the manager portal
    • Tenant Access – When Tenant Access move_in/move_out is triggered
    • Call Center Lead – When a lead created from the call centre

• property_id – this id corresponds to the property id in the account -> data export section
• address – property address where the prospect visited
• summary – the property information presented to the renter at the time of the showing
• checkin_at – time of showing
• prospect_name – full name of the renter
• prospect_phone – phone of renter
• source – technology renter used to view (smartphone or PC or phone)
• property_tag – the CRM ID from the data pull

Prospect comment-only fields

• improvement_type – the area of improvement suggested by the renter
• notes – additional notes
• interest2: Are you interested in renting this property? (apply | question | no),
• access_problem: Was the lock box or key missing or broken? (true | false),
• property_problem: Were there any issues with the property we should be aware of? (vandalism | odor | cleanliness | none)

Example of a prospect survey:

1. Was the lock box or key missing or broken?
   • Yes
   • No

2. Are you interested in renting this property?

• Yes, I’d like to apply
• I’m interested but have some questions
• I’d like to see other properties

3. If you’re not interested, what keeps you from renting the property today?
   Price Interior Condition Exterior Condition Landscaping
   Floor Plan Amenities Location/Neighborhood
   Size N/A – I liked everything about this property
4. Were there any issues with the property we should be aware of?

• Signs of vandalism or break-in
• Odor
• Cleanliness
• No issues

5. Additional Feedback:

Realtor Access Field:

• input – renter’s phone number from a realtor

Tenant Access Fields:

• tenant_name – the name of the tenant during tenant access registration
• tenant_phone – phone of tenant during tenant access registration
• access_type – move_in or move_out

There are other message types:

{

“property_id”: 1377059,
“address”: “4330 Largo Drive, Grand Prairie, TX, USA”,
“summary”: “3BD | 2.1BA | $1,600 /mo | 1800 sq ft”,
“checkin_at”: “04/01/2020 at 06:35AM”,
“checkin_at_iso”: “2020-04-01T06:35:01-07:00”,
“prospect_name”: “Andrea Munoz”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“property_tag”: “”,
“showing_timestamp”: “2020-04-01T06:35:01-07:00”,
“listing_id”: “”,
“secondary_external_id”: “h000067”,
“type”: “Direct Code Showing”,
“leasing_agent”: “Krishna Upadhyaya”

}

 

{

“property_id”: 1265919,
“address”: “1114 Corkscrew Way, Villa Rica, GA 30180 – Unit tag: GA16075”,
“summary”: “5BD | 3.5BA | $1,850 /mo | Cats OK | Dogs OK | 3513 sq ft”,
“checkin_at”: “04/01/2020 at 07:12AM”,
“checkin_at_iso”: “2020-04-01T07:12:53-07:00”,
“prospect_name”: “Cabrina J”,
“prospect_phone”: “(123) 456-7890”,
“email”: “”,
“property_tag”: “GA16075”,
“showing_timestamp”: “2020-04-01T07:12:53-07:00”,
“listing_id”: “GA16075”,
“secondary_external_id”: “h000067”,
“type”: “Open House Scheduling”,
“leasing_agent”: “”

}

 

{

“property_id”: 1268175,
“address”: “7214 Ashley Falls Court, Douglasville, GA 30134 – Unit tag: GA17972”,
“summary”: “4BD | 2.5BA | $1,695 /mo | Cats OK | Dogs OK | 2406 sq ft”,
“checkin_at”: “04/01/2020 at 07:12AM”,
“checkin_at_iso”: “2020-04-01T07:12:54-07:00”,
“prospect_name”: “Zurianna Johnson”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“property_tag”: “GA17972”,
“showing_timestamp”: “2020-04-01T07:12:54-07:00”,
“listing_id”: “GA17972”,
“secondary_external_id”: “h000067”,
“type”: “Open House Viewing”,
“leasing_agent”: “”

}

 

Note: checkin_at and showing_stamp for above “Self Scheduling” both indicate when this schedule is created, instead of when showing is scheduled.

 

{

“property_id”: 1184434,
“address”: “608 REDSTONE AVENUE, EDMOND, OK 73013”,
“summary”: “3BD | 1.5BA | $1,120 /mo | 1126 sq ft”,
“checkin_at”: “04/01/2020 at 07:16AM”,
“checkin_at_iso”: “2020-04-01T07:16:26-07:00”,
“prospect_name”: “Marvin Stoll”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“property_tag”: “c0f7e7d6-e825-4143-a2e3-84c22a77f25f”,
“showing_timestamp”: “2020-04-01T07:16:26-07:00”,
“listing_id”: “c0f7e7d6-e825-4143-a2e3-84c22a77f25f”,
“secondary_external_id”: “h000067”,
“type”: “Self Registered Viewing”,
“source”: “rently.com”

}

 

{

“property_id”: 832886,
“address”: “9630 Calle del Oro Ln, Dallas, TX, 75217 – Unit tag: 96308801”,
“summary”: “3BD | 2BA | $1,575 /mo | Cats OK | Dogs OK | 1308 sq ft”,
“checkin_at”: “04/01/2020 at 10:58AM”,
“checkin_at_iso”: “2020-04-01T10:58:46-07:00”,
“prospect_name”: “Lanita Andrews”,
“prospect_phone”: “(123) 456-7890”,
“email”: “”,
“property_tag”: “96308801”,
“showing_timestamp”: “2020-04-01T10:58:46-07:00”,
“listing_id”: “96308801”,
“secondary_external_id”: “h000067”,
“type”: “OTV Auto Showing”,
“source”: “call_center_guest_card”

}

 

{

“property_id”: 855868,”address”: “123 Main Street, Los Angeles, CA, USA”,
“summary”: “1BD | 1BA | $667 /mo”,
“checkin_at”: “06/05/2019 at 08:09AM”,
“checkin_at_iso”: “2019-06-05T08:09:05-07:00”,
“prospect_name”: “Aaron Fowler”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“property_tag”: “”,
“showing_timestamp”: “2019-06-05T08:09:05-07:00”,
“listing_id”: “”,
“secondary_external_id”: “h000067”,
“type”: “Customer Care Direct Code”,
“leasing_agent”: “”,
“admin_name”: “aaron”

}

 

{

“property_id”: 1288699,
“address”: “125 Rendition Drive, McDonough, GA 30253 – Unit tag:
GA14377”,
“summary”: “3BD | 2BA | $1,550 /mo | Cats OK | Dogs OK | 1644 sq ft”,
“checkin_at”: “04/01/2020 at 07:35AM”,
“checkin_at_iso”: “2020-04-01T07:35:01-07:00”,
“prospect_name”: “Tara Penny”,
“prospect_phone”: “(123) 456-7890”,
“email”: “”,
“property_tag”: “GA14377”,
“showing_timestamp”: “2020-04-01T07:35:01-07:00”,
“listing_id”: “GA14377”,
“secondary_external_id”: “h000067”,
“type”: “Now Available”

}

 

{

“property_id”: 657465,
“address”: “7624 South Marshfield Avenue,Chicago,IL,60620 – Unit tag: p0793911”,
“summary”: “4BD | 2BA | $1,569 /mo | Cats OK | Dogs OK | 1600 sq ft”,
“checkin_at”: “04/01/2020 at 03:22PM”,
“checkin_at_iso”: “2020-04-01T15:22:00-07:00”,
“prospect_name”: “Tarita Smith”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“property_tag”: “p0793911”,
“showing_timestamp”: “2020-04-01T15:22:00-07:00”,
“listing_id”: “p0793911”,
“secondary_external_id”: “h000067”,
“type”: “Safe Mode”

}

 

{

“type”: “Prospect Comment”,
“property_id”: 1223001,
“address”: “713 Tree Green Lane, Wake Forest, NC 27587 – Unit tag: NC17407”,
“summary”: “4BD | 2.5BA | $2,150 /mo | Cats OK | Dogs OK | 2853 sq ft”,
“created_at”: “04/03/2020 at 11:38AM”,
“prospect_name”: “Jordan Blanchard”,
“prospect_phone”: “(123) 456-7890”,
“email”: “test@rently.com”,
“good_arrive”: “”,
“good_leave”: “”,
“interest”: “”,
“rating”: “”,
“improvement_type”: “Price, Landscaping”,
“interest2”: “No”,
“access_problem”: false,
“property_problem”: “none”,
“notes”: “”

}

 

{

“property_id”: 1324536,
“address”: “4102 Johnny Knoll, Winston Salem, NC, 27107 – Unit tag: 45211”,
“summary”: “3BD | 2BA | $1,300 /mo | Cats OK | Dogs OK | 1040 sq ft”,
“checkin_at”: “06/03/2021 at 06:44AM”,
“checkin_at_iso”: “2021-06-03T06:44:13-07:00”,
“listing_id”: “45211”,
“property_tag”: “45211”,
“prospect_name”: “John Doe”,
“prospect_phone”: “(123) 456-7890”,
“email”: “john.doe@example.com”,
“showing_timestamp”: “2021-06-03T06:44:13-07:00”,
“secondary_external_id”: “h000067”,
“source”: “rently_app”,
“type”: “Prelease Lead Signup”

}

 

{

“property_id”: 1164350,
“address”: “372 Griffin St NW, Atlanta, GA, 30314-3842 – Unit tag: 1791197189”,
“summary”: “4BD | 2BA | $1,760 /mo | 1428.0 sq ft”,
“checkin_at”: “04/01/2020 at 05:16AM”,
“checkin_at_iso”: “2020-04-01T05:16:49-07:00”,
“name”: “Angel Jacobo”,
“phone”: “(123) 456-7890”,
“voice_memo”: “”,
“property_tag”: “1791197189”,
“input”: “”,
“type”: “Visitor Unlock”

}

 

{

“property_id”: “”,
“address”: “”,
“summary”: “”,
“checkin_at”: “04/01/2020 at 06:51AM”,
“checkin_at_iso”: “2020-04-01T06:51:53-07:00”,
“name”: “Michael Ewing”,
“phone”: “(123) 456-7890”,
“voice_memo”: “”,
“property_tag”: “”,
“input”: “”,
“type”: “Visitor Unshackle”

}

 

{

“property_id”: 1257964,
“address”: “1631 Harrington Park Drive, Jacksonville, FL 32225 – Unit tag: FL16434”,
“summary”: “5BD | 4BA | $3,195 /mo | Cats OK | Dogs OK | 3472 sq ft”,
“checkin_at”: “04/01/2020 at 04:59PM”,
“checkin_at_iso”: “2020-04-01T16:59:28-07:00”,
“phone”: “+11234567890”,
“property_tag”: “FL16434”,
“type”: “Tenant Access”,
“tenant_name”: “S.Confiado”,
“tenant_phone”: “(123) 456-7890”,
“access_type”: “move_out”

}

 

{
“prospect_name”: “Dana”,
“prospect_phone”: “(123) 456-7890”,
“type”: “Call Center Lead”,
“listing_id”: “p1078910”,
“property_tag”: “p1078910”,
“market_id”: 123,
“market”: “Test Company”,
“showing_timestamp”: “2020-04-01T05:09:55-07:00”,
“checkin_at_iso”: “2020-04-01T05:09:55-07:00”,
“email”: “”,
“move_in_date”: “”,
“notes”: “cx called in asking about the home provide info”,
“max_price”: “”,
“reason_for_move”: “”,
“prospect_status”: “”,
“home_choice_importance”: “”

}

 

{
checkin_id: 123,
property_id: 456,
property_address: “1631 Harrington Park Drive, Jacksonville, FL 32225 – Unit tag: FL16434”,
property_name: “FL16434”,
record_date: 04/01/2020 at 04:59PM,
visitor_phone: “(123) 456-7890”,
visitor_name: “Clark Li”,
visitor_email: “Clark@rently.com”,
source: “Zillow”,
type: “inquiry”
}

Content Type

All examples below use the json content header

• Name: Content-Type
• Value: application/json

API domain: https://secure.rently.com

• use oauth2 with email and password to get access token

access token path

POST /oauth/token

{“grant_type”:”password”, “password”:”12345″, “username”:”clark@rently.com”}

response

{ “access_token”: “3d48f9ccf28d47619d323ff7e4d96a59d1ac34eaf9d859c592a44cff1fb49d33”,

“token_type”: “bearer”, “expires_in”: 7200 }

POST /api/lockboxes/mls_unlock

security header

Once you get the access_token pass authorization header back to all subsequent requests 

• Name: Authorization 

• Value: Bearer 3d48f9ccf28d47619d323ff7e4d96a59d1ac34eaf9d859c592a44cff1fb49d33 

Body 

For lockboxes:

{ 

“serial”:”123456″,  

“name”:”mls agent name”,  

“phone”:”mls agent phone number” ,

“date”:”2001-02-30″

} 

For Rently Blue Locks:

{

“serial”:”123456″,

“name”:”mls agent name”,

“phone”:”mls agent phone number”,

“starttime”:”1539736007″

“endtime”:”1539746007″

}

Response 

{ 

“success”:true,  

“code”:”123456″ 

} 

or 

{ 

“success”:false,  

“message”:”optional error message here” 

}