Lead generation form

The Rent Fetch form is meant to be the quickest, simplest possible way to allow your site to collect leads and send them directly to your PMS. This is currently enabled only for Yardi RentCafe (leads only) and for Entrata (leads and tours). If you’re using another API and want to start collecting leads, please reach out!

View examples of a Yardi lead form, Entrata lead form, and Entrata tour form.

[rentfetch_form] – Drop this shortcode anywhere on your site and it handles everything from form display to lead submission.

Leads vs Tours

There are two basic types of form. There’s a leads form, and a tours form. Leads is the default (available for Yardi and Entrata), or you can set up your form as a Tour (available for Entrata only), using the type parameter.

Basic Setup

Step 1: Ensure Rent Fetch & Rent Fetch Sync (RFS) plugins are installed and up to date on the site.

Step 2: Ensure that your data is syncing to the site (that’s your properties, floor plans/unit types, and units). If they’re already syncing, great! The credentials are just entered in one place, so if your data is already syncing that validates that your API credentials are correct. If your information is not syncing, please configure the Rent Fetch settings or troubleshoot that before proceeding.

Step 4: On the page you’d like to add the contact form, add a shortcode block and use the shortcode below:

[rentfetch_form type=leads]

Step 5: Submit a test lead. PLEASE NOTE: Use a unique email address, last name, and phone number for best results. Most PMS automatically merge leads that are related, so unless you’re testing that specifically, you should try to make sure that your data reflects the most common use case (a brand new lead). If the confirmation text above the form is green immediately after you submit the lead, that indicates that the API has received the lead successfully.

Step 6: Check within your PMS to make sure that you received the lead.

Lead Source Tracking

The lead_source parameter helps track marketing effectiveness:

• Automatic Population: The form automatically captures lead source from URL parameters: ?lead_source=google-ads. You don’t have to send people directly to the contact page, though. Sending users to yoursite.com?lead_source=google-ads is enough, even if the form appears on a different page of your site.
• Manual Setting: Override with shortcode parameter for specific campaigns
• Backend Storage: All lead sources are stored with submissions for reporting and fallback.
• Failsafe: If a lead fails to submit to your API, the user is shown an error message. We do NOT fail silently.

NOTE: Yardi in particular requires that a lead source, if given match perfectly with your property’s preconfigured lead sources. You can’t make these up on the fly, as their API will reject lead sources that don’t match.

Supported APIs

The form integrates with major property management platforms:

• Entrata – Full lead submission with tour scheduling support
• Yardi – Lead submission and tracking
• RentManager – Not yet supported.

The system automatically detects which API to use based on the property’s configured source.

Available Shortcode Parameters

There are a number of options available when setting up a lead form. You can set these options by passing them as parameters in the shortcode, e.g. [rentfetch_form parameter=value]. For parameters that include spaces, you’ll need to use quotes (make sure the quotes are straight and not curly), like this: [rentfetch_form parameter="value1, value2"].

• type: Form type – leads (default) or tour
  • leads: Standard contact form
  • tour: Includes date/time selection for tour scheduling
• confirmation: Custom success message after form submission
  • Default: “Thanks for your submission. We will get back to you shortly.”
  • Example: [rentfetch_form confirmation="We'll contact you within 24 hours!"]
• property: Pre-select a specific property by ID
  • If set, the property dropdown is hidden and this property is automatically selected
  • Can also be set via URL parameter: ?property=p12345
  • Example: [rentfetch_form property="p12345"]
• lead_source: Track where leads come from
  • Can be set in shortcode or automatically populated from URL parameters/cookies
  • Useful for marketing attribution
  • Example: [rentfetch_form lead_source="website-contact"]
• submit_label: Custom text for the submit button
  • Defaults to “Send Message” for leads, “Schedule Tour” for tours
  • Example: [rentfetch_form submit_label="Get Started"]
• redirection_url: Redirect users to a specific page after successful submission
  • Example: [rentfetch_form redirection_url="/thank-you"]

Form Types

Lead Form (default):

[rentfetch_form type="leads"]

• Standard contact form
• Fields: Name, Email, Phone, Property, Message

Tour Scheduling (Entrata only):

[rentfetch_form type="tour"]

• Includes date/time selection
• Integrates with Entrata’s tour booking system
• Additional fields: Appointment date, start/end times

Advanced Examples

Pre-select property and customize messaging:

[rentfetch_form property="p12345" confirmation="Thanks for your interest in Oakwood Apartments!" submit_label="Contact Us"]

Tour form with lead tracking preset:

[rentfetch_form type="tour" lead_source="homepage-tour-form" confirmation="Your tour is scheduled!"]

Backend Lead Management

All form submissions are stored in the WordPress database with full details:

• Contact information
• Selected property
• Lead source tracking
• API submission status
• Error logs for failed submissions

Technical Notes

• AJAX Submission: Forms submit via AJAX for better user experience
• Spam Protection: Includes honeypot field and nonce verification
• Validation: Client and server-side validation
• Error Handling: Graceful error messages with fallback storage

The form’s simplicity belies its power – just drop the shortcode and it handles complex API integrations automatically.