POST /v1/:facility_id/tenants/leads/rent_now
Create a tenant with one or more rent-now reservations

This API enables creating Rent-now reservations for facilities that support this feature.

It sets the rent_now attribute to true and the desired_move_in_date to the current date.

Prerequisites

  • flipper_fms_rent_now must be enabled for the facility or else the request will fail
  • is_reservation must be set to true
  • unit_group_id must be provided

Sample error responses

  • 400 for flipper_fms_rent_now not enabled

{
"statuscode": 400,
"statusmessage": "Bad Request",
"message": "Rent-now reservations are not available for this store."
}
* 400 for is_reservation not set to true

{
"statuscode": 400,
"statusmessage": "Bad Request",
"message": "is_reservation must be true when creating a rent-now reservation"
}

Params

Param name Description
first_name
required
Value: Must be a String
last_name
optional
Value: Must be a String
email
optional
Value: Must be a String
is_business
optional

True if the tenant record is a commercial entity.


Value: Must be one of: <code>true</code>, <code>false</code>.
phone_numbers_attributes
required

A collection of phone numbers. At least one is required.


Value: Must be an Array of nested elements
phone_numbers_attributes[number]
required

Phone number


Value: Must be a String
phone_numbers_attributes[extension]
optional

Phone number extension


Value: Must be a String
phone_numbers_attributes[label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.


Value: Must be a String
phone_numbers_attributes[sms_opt_in]
optional

Opt the tenant in to SMS (if applicable). Requires a "Mobile" label for SMS to work correctly.


Value: Must be one of: <code>true</code>, <code>false</code>.
mailing_address_attributes
optional
Value: Must be a Hash
mailing_address_attributes[address1]
optional
Value: Must be a String
mailing_address_attributes[address2]
optional
Value: Must be a String
mailing_address_attributes[city]
optional
Value: Must be a String
mailing_address_attributes[state]
optional
Value: Must be a String
mailing_address_attributes[postal]
optional
Value: Must be a String
mailing_address_attributes[time_zone]
optional

Valid IANA timezone identifier of the address (see http://www.iana.org/time-zones)


Value: Must be a String
leads_attributes
required
Value: Must be an Array of nested elements
leads_attributes[unit_id]
optional

The ID of the unit to reserve. Required if is_reservation is true. Will be ignored if not in the same unit group as the given unit_group_id or unit's existing unit group.


Value: Must be a String
leads_attributes[unit_group_id]
optional

The ID of the unit group to reserve (the first available unit will be selected).


Value: Must be a String
leads_attributes[id]
optional

The ID of the lead (update only).


Value: Must be a String
leads_attributes[is_reservation]
required

Is the lead a reservation?


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[caller_first_name]
optional

First name of the caller, if different from the tenant


Value: Must be a String
leads_attributes[caller_last_name]
optional

Last name of the caller, if different from the tenant


Value: Must be a String
leads_attributes[urgent]
optional
Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[quoted_rate]
optional
Value: Must be a String
leads_attributes[length_of_stay_id]
optional

The ID of the length of stay for the lead. You can get a list of length of stays from the company configuration.


Value: Must be a String
leads_attributes[size]
optional
Value: Must be a String
leads_attributes[floor]
optional
Value: Must be a String
leads_attributes[lead_contents]
optional

A collection of marketing content.


Value: Must be an Array of nested elements
leads_attributes[lead_contents][id]
optional

The ID of the marketing content for the lead. You can get a list of contents from the company configuration.


Value: Must be a String
leads_attributes[desired_move_in_date]
optional

Format: YYYY-MM-DD


Value: Must be a Date
leads_attributes[desired_unit_size_and_price]
optional

A String representing the size and price that the user is interested in. Get the possible options from the GET /unit_groups resource.


Value: Must be a String
leads_attributes[free_truck]
optional

Interested in a free truck


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[moving_labor]
optional

Interested in having help with moving


Value: Must be one of: <code>true</code>, <code>false</code>.
leads_attributes[call_source]
optional

Where the call was initiated from


Value: Must be a String
leads_attributes[dnis]
optional

An identifier for the facility the lead was trying to reach - see http://en.wikipedia.org/wiki/Dialed_Number_Identification_Service


Value: Must be a String
leads_attributes[close_reason_id]
optional

The ID of the reason for closing the lead. You can get a list of reasons from the company configuration.


Value: Must be a String
leads_attributes[lead_action_performed]
optional

The kind of action that was performed on the lead


Value: Must be one of: <code>call</code>, <code>email</code>, <code>text</code>.
leads_attributes[lead_action_performed_index]
optional

The numeric value for the action performed (i.e. if this was the second call a "2" would be used)


Value: Must be a Integer
leads_attributes[next_lead_action]
optional

The kind of follow up action that will be performed


Value: Must be one of: <code>call</code>, <code>email</code>, <code>text</code>.
leads_attributes[notes_attributes]
optional

A collection of notes.


Value: Must be an Array of nested elements
leads_attributes[notes_attributes][note]
required

Note body - freeform text


Value: Must be a String
leads_attributes[caller_phone_number_attributes]
required

Phone number of the caller, if different from the tenant


Value: Must be a Hash
leads_attributes[caller_phone_number_attributes][number]
required

Phone number


Value: Must be a String
leads_attributes[caller_phone_number_attributes][extension]
optional

Phone number extension


Value: Must be a String
leads_attributes[caller_phone_number_attributes][label]
optional

A label for what the phone number is, such as Home, Work, Mobile, etc.


Value: Must be a String
leads_attributes[rate_type]
optional

The type of rate for the unit (ie. standard_rate, managed_rate, custom_rate, or channel_rate).


Value: Must be a String
leads_attributes[discount_plans]
optional

Must be an array of nested discount plan ids


Value: Must be an Array of nested elements
leads_attributes[discount_plans][id]
optional

The ID of the discount plan to apply.


Value: Must be a String