POST /v1/:facility_id/leads
Create a new lead
Examples
POST /v1/54a596cb-08bf-45ac-9a1a-1a2483eb1d3c/leads
{
"lead": {
"desired_move_in_date": "2022-09-14",
"is_reservation": "true",
"tenant_attributes": {
"first_name": "John",
"phone_numbers_attributes": [
{
"number": "3333333333",
"sms_opt_in": "true"
}
]
},
"unit_id": "0f112435-ce1c-47ea-bf55-6740601e5870"
},
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "00000000",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"security_code": "123"
}
}
201
{
"lead": {
"id": "42a4bd0b-a55d-4c70-b968-0ee685083283",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000003-1-1669",
"created_at": "2022-09-12T22:36:42.248-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "6x10x2 at $871.63",
"due_at_move_in": 493.92,
"due_monthly": 871.63,
"extra_details": {
"saved_cyo_options_ids": "[]",
"snapshot_reservation_id": "22e53ecd-1c22-44ce-80b7-7a3bb96514b3"
},
"facility_id": "54a596cb-08bf-45ac-9a1a-1a2483eb1d3c",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": true,
"invoiceable_fees": [],
"kind": "internet",
"lead_action_indexes": {},
"length_of_stay_id": null,
"move_in_from_reservation_url": null,
"moved_in_at": null,
"moving_labor": false,
"moving_labor_contacted_already": false,
"next_action_at": "2022-09-12T00:00:00.000-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "reservation",
"plant_a_tree": false,
"quoted_rate": 871.63,
"rate_type": "standard_rate",
"reduced_price": 871.63,
"reservation_fee_required": true,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:42.243-10:00",
"size": "6x10x2",
"source_id": "4fad3a5d-96b2-472e-9e5c-1e2c6b639be4",
"source_name": "Test App",
"standard_rate": 871.63,
"started_at": "2022-09-12T22:36:42.248-10:00",
"status": "reserved",
"tenant_id": "dbbcaea5-251b-4886-86e2-b3c9b4226caf",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "dbbcaea5-251b-4886-86e2-b3c9b4226caf",
"account_number": 1000003,
"first_name": "John",
"last_name": null,
"middle_initial": null,
"email": null,
"tax_exempt": false,
"is_military": false,
"is_business": false,
"business_name": null,
"last_sign_in_at": null,
"title": null,
"delinquent": false,
"current_ledger_ids": [],
"preferences": {
"email_invoices": true,
"print_invoices": false,
"charge_invoice_fee": true,
"receive_legal_notices_by_email": null,
"delinquency_exempt": false,
"delinquency_docs_by_email": false,
"delinquency_docs_by_mail": false,
"receive_sms_for_gate_activity": false,
"opt_in_to_marketing_emails": false,
"opt_in_to_marketing_sms": false,
"opt_in_to_transactional_sms": false,
"exclude_from_insurance_auto_enroll": false,
"exclude_from_insurance_auto_enroll_reason": null,
"exclude_from_insurance_auto_enroll_created_by": null,
"exclude_from_insurance_auto_enroll_on": null
},
"military_information": null,
"username": null,
"drivers_license_number": null,
"drivers_license_state": null,
"vehicle_license_plate_number": null,
"vehicle_license_state": null,
"vehicle_description": null,
"has_tenant_portal_account": false,
"created_at": "2022-09-12T22:36:42.041-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "1cbe2482-50c5-492f-9295-20ff393c1f8a",
"primary": true,
"source": null,
"number": "+13333333333",
"formatted_number": "(333) 333-3333",
"extension": null,
"label": null,
"unformatted_number": "3333333333",
"sms_opt_in": true
}
],
"mailing_address": null,
"addresses": [],
"facility_id": "54a596cb-08bf-45ac-9a1a-1a2483eb1d3c",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"f4b71881-f927-4e32-b876-0bd4d05f9933",
"8dc945bc-e941-4917-9284-d05c40172d2c"
],
"password_recovery_question_ids": []
},
"unit": {
"id": "0f112435-ce1c-47ea-bf55-6740601e5870",
"price": 871.63,
"name": "U37",
"description": "",
"width": 6.0,
"length": 10.0,
"height": 2.0,
"door_height": 10.0,
"door_width": 3.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "6x10x2",
"area": 60.0,
"standard_rate": 871.63,
"managed_rate": null,
"available_for_move_in": false,
"rentable": true,
"status": "reserved",
"payment_status": null,
"current_ledger_id": null,
"current_tenant_id": null,
"combo_lock_group": null,
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": null,
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": null,
"tiering": {
"cross_sell_group_id": 1960,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "40f74d9c-5dc8-4dc1-b165-7cc1f051f8ef",
"name": "Unit Type 37",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "ab1f6611-d349-4af6-bb0c-0260bf27f50d"
},
"length_of_stay": null,
"successful_payment_events": [
{
"id": "8dc945bc-e941-4917-9284-d05c40172d2c",
"amount": 5.99,
"success": true,
"date": "2022-09-12T22:36:42.092-10:00",
"payment_method": {
"id": "f2c87a10-e7f5-4554-a9d3-82bb8eca935e",
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": false,
"card_number": "****0000",
"card_type": "visa",
"expiration_date": "10/24",
"billing_address": {
"id": "9bb9b6b7-7187-4d8e-871a-72aa8060ab5d",
"address1": "123 Main",
"address2": null,
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US",
"full_address": "123 Main, Somecity, AL 12345",
"latitude": null,
"longitude": null,
"time_zone_id": "America/Chicago",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
}
}
}
],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "40f74d9c-5dc8-4dc1-b165-7cc1f051f8ef",
"name": "Unit Type 37",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "ab1f6611-d349-4af6-bb0c-0260bf27f50d",
"price": 871.63,
"group_key": "6x10x2 - $871.63 - 2007",
"name": "6x10x2 - $871.63 - 2007",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "6x10x2",
"standard_rate": 871.63,
"floor": null,
"reduced_price": 871.63,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 60.0,
"length": 10.0,
"width": 6.0,
"height": 2.0,
"due_at_move_in": 871.63,
"due_at_move_in_without_fees": 871.63,
"due_monthly": 871.63,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": {
"id": "10fce335-86c2-48ee-a205-4b98d86fd4a7",
"product_code": "FEE-1",
"kind": "fee",
"description": "some fee",
"required_at_move_in": false,
"required_at_transfer": false,
"amount": 5.99,
"short_description": null,
"show_in_sales_center": false,
"tax_total": 0.0,
"total": 5.99
},
"tiering": {
"cross_sell_group_id": 1960,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "40f74d9c-5dc8-4dc1-b165-7cc1f051f8ef",
"name": "Unit Type 37",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"discount_plans": [],
"channel_rate_ids": [],
"available_upgrade_to_unit_groups": []
},
"created_by": null,
"channel_id": "4fad3a5d-96b2-472e-9e5c-1e2c6b639be4",
"confirmation_email": null
},
"meta": {
"status_code": 201,
"status_message": "Created",
"status_cat": "https://http.cat/201",
"request_method": "POST",
"request_id": null,
"parameters": {
"lead": {
"desired_move_in_date": "2022-09-14",
"is_reservation": "true",
"tenant_attributes": {
"first_name": "John",
"phone_numbers_attributes": [
{
"number": "3333333333",
"sms_opt_in": "true"
}
]
},
"unit_id": "0f112435-ce1c-47ea-bf55-6740601e5870"
},
"payment_method": {
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"country": "US",
"postal": "12345",
"state": "AL"
},
"card_number": "[FILTERED]",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"security_code": "[FILTERED]"
},
"facility_id": "54a596cb-08bf-45ac-9a1a-1a2483eb1d3c"
}
}
}
Params
| Param name | Description |
|---|---|
|
lead required |
Value: Must be a Hash |
|
lead[tenant_id] optional |
A tenant record to associate the lead with. Required if Value: Must be a String |
|
lead[tenant_attributes] optional |
Attributes to create a tenant record. Required if Value: Must be a Hash |
|
lead[tenant_attributes][title] optional |
Value: Must be a String |
|
lead[tenant_attributes][first_name] required |
Value: Must be a String |
|
lead[tenant_attributes][last_name] optional |
Value: Must be a String |
|
lead[tenant_attributes][middle_initial] optional |
Value: Must be a String |
|
lead[tenant_attributes][last_name] optional |
Value: Must be a String |
|
lead[tenant_attributes][email] optional |
Value: Must be a String |
|
lead[tenant_attributes][is_military] optional |
True if the tenant record is a in the military. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[tenant_attributes][is_business] optional |
True if the tenant record is a commercial entity. Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[tenant_attributes][phone_numbers_attributes] required |
A collection of phone numbers. At least one is required. Value: Must be an Array of nested elements |
|
lead[tenant_attributes][phone_numbers_attributes][number] required |
Phone number Value: Must be a String |
|
lead[tenant_attributes][phone_numbers_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
lead[tenant_attributes][phone_numbers_attributes][label] optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Value: Must be a String |
|
lead[tenant_attributes][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>. |
|
lead[tenant_attributes][mailing_address_attributes] optional |
Value: Must be a Hash |
|
lead[tenant_attributes][mailing_address_attributes][address1] optional |
Value: Must be a String |
|
lead[tenant_attributes][mailing_address_attributes][address2] optional |
Value: Must be a String |
|
lead[tenant_attributes][mailing_address_attributes][city] optional |
Value: Must be a String |
|
lead[tenant_attributes][mailing_address_attributes][state] optional |
Value: Must be a String |
|
lead[tenant_attributes][mailing_address_attributes][postal] optional |
Value: Must be a String |
|
lead[tenant_attributes][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 |
|
lead[unit_id] optional |
The ID of the unit to reserve. Required if Value: Must be a String |
|
lead[online_move_in_url] optional |
The URL the lead can use to complete the move in Value: Must be a String |
|
lead[id] optional |
The ID of the lead (update only). Value: Must be a String |
|
lead[is_reservation] required |
Is the lead a reservation? Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[caller_first_name] optional |
First name of the caller, if different from the tenant Value: Must be a String |
|
lead[caller_last_name] optional |
Last name of the caller, if different from the tenant Value: Must be a String |
|
lead[urgent] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[quoted_rate] optional |
Value: Must be a String |
|
lead[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 |
|
lead[size] optional |
Value: Must be a String |
|
lead[floor] optional |
Value: Must be a String |
|
lead[lead_contents] optional |
A collection of marketing content. Value: Must be an Array of nested elements |
|
lead[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 |
|
lead[desired_move_in_date] optional |
Format: YYYY-MM-DD Value: Must be a Date |
|
lead[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 |
|
lead[free_truck] optional |
Interested in a free truck Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[moving_labor] optional |
Interested in having help with moving Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[call_source] optional |
Where the call was initiated from Value: Must be a String |
|
lead[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 |
|
lead[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 |
|
lead[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>. |
|
lead[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 |
|
lead[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>. |
|
lead[notes_attributes] optional |
A collection of notes. Value: Must be an Array of nested elements |
|
lead[notes_attributes][note] required |
Note body - freeform text Value: Must be a String |
|
lead[caller_phone_number_attributes] required |
Phone number of the caller, if different from the tenant Value: Must be a Hash |
|
lead[caller_phone_number_attributes][number] required |
Phone number Value: Must be a String |
|
lead[caller_phone_number_attributes][extension] optional |
Phone number extension Value: Must be a String |
|
lead[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 |
|
lead[rate_type] optional |
The type of rate for the unit (ie. Value: Must be a String |
|
lead[discount_plans] optional |
Must be an array of nested discount plan ids Value: Must be an Array of nested elements |
|
lead[discount_plans][id] optional |
The ID of the discount plan to apply. Value: Must be a String |
|
lead[payment_method] required |
Can accept a paymentmethodid, or fields for CC or ACH payments Value: Must be a Hash |
|
lead[payment_method][payment_method_id] optional |
If you want to use an existing payment method, pass in the id Value: Must be a String |
|
lead[payment_method][first_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
lead[payment_method][last_name] optional |
Required if not using an existing payment method Value: Must be a String |
|
lead[payment_method][kind] optional |
Required if not using an existing payment method Value: Must be one of: <code>ach</code>, <code>credit_card</code>, <code>check</code>, <code>cash</code>, <code>card_swipe</code>. |
|
lead[payment_method][reuseable] optional |
Value: Must be one of: <code>true</code>, <code>false</code>. |
|
lead[payment_method][magnetic_track] optional |
Required if using a card swipe Value: Must be a String |
|
lead[payment_method][card_number] optional |
Required if using a credit card Value: Must be a String |
|
lead[payment_method][card_type] optional |
Required if using a credit card Value: Must be one of: <code>visa</code>, <code>mastercard</code>, <code>american_express</code>, <code>diners</code>, <code>discover</code>, <code>jcb</code>. |
|
lead[payment_method][security_code] optional |
Required if using a credit card Value: Must be a String |
|
lead[payment_method][expiration_date] optional |
Required if using a credit card. Format: MM/YY Value: Must be a String |
|
lead[payment_method][account_number] optional |
Required if using ACH Value: Must be a String |
|
lead[payment_method][account_number_confirmation] optional |
Required if using ACH Value: Must be a String |
|
lead[payment_method][account_type] optional |
Required if using ACH Value: Must be a String |
|
lead[payment_method][bank_name] optional |
Required if using ACH Value: Must be a String |
|
lead[payment_method][routing_number] optional |
Required if using ACH Value: Must be a String |
|
lead[payment_method][billing_address_attributes] optional |
Required if not using an existing payment method Value: Must be a Hash |
|
lead[payment_method][billing_address_attributes][company] optional |
Value: Must be a String |
|
lead[payment_method][billing_address_attributes][address1] optional |
Value: Must be a String |
|
lead[payment_method][billing_address_attributes][address2] optional |
Value: Must be a String |
|
lead[payment_method][billing_address_attributes][city] optional |
Value: Must be a String |
|
lead[payment_method][billing_address_attributes][postal] optional |
Value: Must be a String |
|
lead[payment_method][billing_address_attributes][state] optional |
Value: Must be a String |
|
lead[payment_method][check_number] optional |
Required if using Check Value: Must be a String |
|
lead[payment_method][name_on_check] optional |
Required if using Check Value: Must be a String |
|
lead[payment_method][check_amount] optional |
Required if using Check Value: Must be a String |
|
lead[payment_method][reference_number] optional |
Required if using Money Order Value: Must be a String |
|
lead[payment_method][money_order_amount] optional |
Required if using Money Order Value: Must be a String |
|
lead[payment_method][amount_tendered] optional |
Required if using Cash Value: Must be a String |