Leads
Leads and reservations
Discussion
A lead encompasses two related ideas:
- A record indicating interest in the facility (an inquiry).
- A reservation on a particular unit.
A lead has a tenant record associated with it. Although the record is of type "tenant", the tenant does not necessarily have to be moved-in to the facility; it is just a means of storing data about the person.
A lead becomes a reservation if it has a unit attached to it. A lead may start out as a reservation or be converted to one later by attaching a unit.
*A facility has the option to disable tenants from making payments, in the event this has been applied and the tenant has been provided in the parameters, a tenant will not be able to make a payment via the API calls listed here.
GET /v1/:facility_id/leads
Show all leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/fcac6ae3-3974-4e21-9078-8a572eb596cb/leads
200
{
"leads": [
{
"id": "8efb5bf7-29fa-4017-85b6-0fc586178858",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1646",
"created_at": "2022-09-12T22:36:37.780-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "6x4x6 at $473.74",
"due_at_move_in": 268.45,
"due_monthly": 473.74,
"extra_details": {
"snapshot_reservation_id": "913efa2a-185c-4122-b36a-a0bcabfe7aee"
},
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:37.759-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 473.74,
"rate_type": null,
"reduced_price": 473.74,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:37.819-10:00",
"size": "6x4x6",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:37.781-10:00",
"status": "reserved",
"tenant_id": "dc9f59ec-0ea9-4f0f-910b-53acde7dfc23",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "dc9f59ec-0ea9-4f0f-910b-53acde7dfc23",
"account_number": 1000001,
"first_name": "Sonia39",
"last_name": "Wehner",
"middle_initial": null,
"email": "cordell@mills.biz39",
"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": "username_39",
"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:37.766-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "e27b22ba-4929-4a07-8990-6a121ea861c3",
"address1": "2895396 Lebsack Station",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2895396 Lebsack Station, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "e27b22ba-4929-4a07-8990-6a121ea861c3",
"address1": "2895396 Lebsack Station",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2895396 Lebsack Station, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"50c1e8e2-89d7-4aa8-b2c5-79880f2fa981"
],
"password_recovery_question_ids": [
"7f5732e4-5234-46b5-b0ab-d37a650c94d1",
"8ba74437-1469-4546-a619-12654a775dd4"
]
},
"unit": {
"id": "0bc2afeb-e53a-4434-8dd2-4f7145a51d04",
"price": 473.74,
"name": "U29",
"description": "",
"width": 6.0,
"length": 4.0,
"height": 6.0,
"door_height": 3.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "6x4x6",
"area": 24.0,
"standard_rate": 473.74,
"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": 1952,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "6870d400-0a1a-4e46-8d20-0b706ea4dd74"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "6870d400-0a1a-4e46-8d20-0b706ea4dd74",
"price": 473.74,
"group_key": "6x4x6 - $473.74 - 1999",
"name": "6x4x6 - $473.74 - 1999",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "6x4x6",
"standard_rate": 473.74,
"floor": null,
"reduced_price": 473.74,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 24.0,
"length": 4.0,
"width": 6.0,
"height": 6.0,
"due_at_move_in": 473.74,
"due_at_move_in_without_fees": 473.74,
"due_monthly": 473.74,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1952,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "bbdc8a10-9ea8-41bb-bd99-9e66dce71bf8",
"name": "Unit Type 29",
"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": {
"id": "ec4fb36f-f507-4573-9fa7-de62a9117965",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "5dcf839c-8fac-4c63-8e09-ebf7db2a55a3",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:37.735-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:37.656-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:37.735-10:00",
"status": "created",
"tenant_id": "e3d019a7-6358-4db5-b4db-981c7cc6efd2",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "e3d019a7-6358-4db5-b4db-981c7cc6efd2",
"account_number": 1000000,
"first_name": "Alethia38",
"last_name": "Wehner",
"middle_initial": null,
"email": "jacintoadams@dooley.co38",
"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": "username_38",
"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:37.712-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "146e4e35-8e2c-46aa-83e8-e09a10bedcde",
"address1": "288220 Andrew Drive",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "288220 Andrew Drive, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "146e4e35-8e2c-46aa-83e8-e09a10bedcde",
"address1": "288220 Andrew Drive",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "288220 Andrew Drive, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"ffcb810a-7b55-4c31-bfba-a3efc3f34580"
],
"password_recovery_question_ids": [
"1dd7c92f-2494-4a3f-a2ec-0e1c48d204a0",
"5537b141-283d-4a6b-966b-60a7caf0f7b3"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "ec4fb36f-f507-4573-9fa7-de62a9117965",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "fcac6ae3-3974-4e21-9078-8a572eb596cb"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/current
Show all current leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9/leads/current
200
{
"leads": [
{
"id": "de32d55b-a83e-4c8a-8e08-51adcdd975bf",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1655",
"created_at": "2022-09-12T22:36:39.433-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "10x6x4 at $305.62",
"due_at_move_in": 173.18,
"due_monthly": 305.62,
"extra_details": {
"snapshot_reservation_id": "711f7e01-1826-4653-97d3-bf45b9bd0fb9"
},
"facility_id": "c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:39.412-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 305.62,
"rate_type": null,
"reduced_price": 305.62,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:39.470-10:00",
"size": "10x6x4",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:39.433-10:00",
"status": "reserved",
"tenant_id": "4bcf7d33-adde-4a4b-9794-69f58a6aaf3c",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "4bcf7d33-adde-4a4b-9794-69f58a6aaf3c",
"account_number": 1000001,
"first_name": "Treasa48",
"last_name": "Wehner",
"middle_initial": null,
"email": "dominque@murazik.co48",
"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": "username_48",
"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:39.419-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "28bd07bc-faa6-401c-9d64-c467cdf30f81",
"address1": "31338002 German Stravenue",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "31338002 German Stravenue, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "28bd07bc-faa6-401c-9d64-c467cdf30f81",
"address1": "31338002 German Stravenue",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "31338002 German Stravenue, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"8008eb36-21fa-4f22-bf81-8b5668f2eaa2"
],
"password_recovery_question_ids": [
"0712453f-58c9-4d16-bf77-8536c3ad4b41",
"a44d75e6-3240-4bd8-8274-5efc29b5fb04"
]
},
"unit": {
"id": "3508c036-569a-4659-9bf2-9faf673a4d99",
"price": 305.62,
"name": "U32",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 4.0,
"door_height": 3.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x4",
"area": 60.0,
"standard_rate": 305.62,
"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": 1955,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "d2e5e151-ba85-4c3a-a418-0f6247e37068",
"name": "Unit Type 32",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "b5a96aa3-5b34-4a6e-94ea-40ef40b22712"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "d2e5e151-ba85-4c3a-a418-0f6247e37068",
"name": "Unit Type 32",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "b5a96aa3-5b34-4a6e-94ea-40ef40b22712",
"price": 305.62,
"group_key": "10x6x4 - $305.62 - 2002",
"name": "10x6x4 - $305.62 - 2002",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "10x6x4",
"standard_rate": 305.62,
"floor": null,
"reduced_price": 305.62,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 60.0,
"length": 6.0,
"width": 10.0,
"height": 4.0,
"due_at_move_in": 305.62,
"due_at_move_in_without_fees": 305.62,
"due_monthly": 305.62,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1955,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "d2e5e151-ba85-4c3a-a418-0f6247e37068",
"name": "Unit Type 32",
"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": {
"id": "71292cb8-7e5a-4871-b010-ee19a277b76f",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "6558fcfd-2a49-4bba-b3a9-52004145b7a4",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:39.390-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:39.367-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:39.390-10:00",
"status": "created",
"tenant_id": "b5e9e219-db49-4209-8d18-5cb8621d5869",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "b5e9e219-db49-4209-8d18-5cb8621d5869",
"account_number": 1000000,
"first_name": "Dario47",
"last_name": "Wehner",
"middle_initial": null,
"email": "karlcorkery@carrollrempel.co47",
"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": "username_47",
"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:39.374-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "d8b18a61-9306-4c34-8f1c-0c3dc0678703",
"address1": "312947 Brekke Point",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "312947 Brekke Point, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "d8b18a61-9306-4c34-8f1c-0c3dc0678703",
"address1": "312947 Brekke Point",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "312947 Brekke Point, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"abdb2770-bd1a-48bd-83ae-de77fbd3be4c"
],
"password_recovery_question_ids": [
"8dfa59da-a495-4e1a-987f-dd7ceb73e51b",
"b6f75c63-ac36-44c2-995e-64203aac2459"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "71292cb8-7e5a-4871-b010-ee19a277b76f",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "c08b2c79-9bef-4e1e-b1c2-cff3fb28fbc9"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/follow_up
Show all followup leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/12cf1ce0-5c9e-4482-a00f-998b14eb716c/leads/follow_up
200
{
"leads": [
{
"id": "921fca55-4ad2-441d-b0df-c12687ed1876",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1652",
"created_at": "2022-09-12T22:36:38.862-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "7x2x1 at $927.66",
"due_at_move_in": 525.67,
"due_monthly": 927.66,
"extra_details": {
"snapshot_reservation_id": "749cb95a-df52-4918-97bf-ba306211b018"
},
"facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:38.842-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 927.66,
"rate_type": null,
"reduced_price": 927.66,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:38.903-10:00",
"size": "7x2x1",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:38.862-10:00",
"status": "reserved",
"tenant_id": "a574ea1a-d2c4-49c0-bd0f-b48e8fafae44",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "a574ea1a-d2c4-49c0-bd0f-b48e8fafae44",
"account_number": 1000001,
"first_name": "Scot45",
"last_name": "Wehner",
"middle_initial": null,
"email": "clarinepouros@mertztoy.com45",
"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": "username_45",
"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:38.848-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "863e1a62-23e5-4437-91f1-1dd664fb3f6a",
"address1": "305552 Berge Divide",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "305552 Berge Divide, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "863e1a62-23e5-4437-91f1-1dd664fb3f6a",
"address1": "305552 Berge Divide",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "305552 Berge Divide, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"5a290595-3e17-4478-b1aa-50d25dc8b3ab"
],
"password_recovery_question_ids": [
"faf9ac9a-749d-4de9-a635-a9b398e39236",
"9049e796-8e50-4e5a-a86d-da6a6a05c1fd"
]
},
"unit": {
"id": "c22004e3-5cfb-4de0-8389-26960becc226",
"price": 927.66,
"name": "U31",
"description": "",
"width": 7.0,
"length": 2.0,
"height": 1.0,
"door_height": 8.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "7x2x1",
"area": 14.0,
"standard_rate": 927.66,
"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": 1954,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
"name": "Unit Type 31",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "b3654cbe-a02a-4396-a3f7-3bc43702453e"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
"name": "Unit Type 31",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "b3654cbe-a02a-4396-a3f7-3bc43702453e",
"price": 927.66,
"group_key": "7x2x1 - $927.66 - 2001",
"name": "7x2x1 - $927.66 - 2001",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "7x2x1",
"standard_rate": 927.66,
"floor": null,
"reduced_price": 927.66,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 14.0,
"length": 2.0,
"width": 7.0,
"height": 1.0,
"due_at_move_in": 927.66,
"due_at_move_in_without_fees": 927.66,
"due_monthly": 927.66,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1954,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "b9371e24-47e4-46e3-84c8-bdf5020b0960",
"name": "Unit Type 31",
"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": {
"id": "fdf3e8c8-c7de-4216-a1e5-e75170e953aa",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "aa23ce02-16f8-47a9-b692-633c42da1711",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:38.822-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:38.799-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:38.822-10:00",
"status": "created",
"tenant_id": "f00ec1f6-7800-4e1c-a079-99b1b9c85fc5",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "f00ec1f6-7800-4e1c-a079-99b1b9c85fc5",
"account_number": 1000000,
"first_name": "Donnie44",
"last_name": "Wehner",
"middle_initial": null,
"email": "chadwickkuphal@jacobsonrippin.name44",
"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": "username_44",
"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:38.806-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "80f77e88-ad34-46a3-897d-666db8b31829",
"address1": "304119 Feeney Orchard",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "304119 Feeney Orchard, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "80f77e88-ad34-46a3-897d-666db8b31829",
"address1": "304119 Feeney Orchard",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "304119 Feeney Orchard, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"010c4d42-9878-4bb7-b4aa-772a0fef4f31"
],
"password_recovery_question_ids": [
"d7c820c1-8083-4e00-82b3-f350cc9f371c",
"6042d472-5a1b-4bd3-8ef9-314a9ec55339"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "fdf3e8c8-c7de-4216-a1e5-e75170e953aa",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 2,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "12cf1ce0-5c9e-4482-a00f-998b14eb716c"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/reservations
Show all leads that are reservations
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/d62629d4-269b-41fd-8fc2-fadf9c38fe20/leads/reservations
200
{
"leads": [
{
"id": "0feb1499-a10a-445c-9d9e-3c6ecc45b024",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1658",
"created_at": "2022-09-12T22:36:39.997-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "2x8x3 at $932.14",
"due_at_move_in": 528.21,
"due_monthly": 932.14,
"extra_details": {
"snapshot_reservation_id": "7e4f8f4a-fb8e-4cd2-ac4a-af30fb554aeb"
},
"facility_id": "d62629d4-269b-41fd-8fc2-fadf9c38fe20",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:39.976-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 932.14,
"rate_type": null,
"reduced_price": 932.14,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:40.034-10:00",
"size": "2x8x3",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:39.997-10:00",
"status": "reserved",
"tenant_id": "15fc0d2c-5bc2-4e48-b619-677b50cbcb3b",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "15fc0d2c-5bc2-4e48-b619-677b50cbcb3b",
"account_number": 1000001,
"first_name": "Ramiro51",
"last_name": "Wehner",
"middle_initial": null,
"email": "elinor@kohlercarter.co51",
"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": "username_51",
"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:39.983-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "e16293ae-4808-45bd-91bc-ec7040b918a6",
"address1": "321233 Veum Square",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "321233 Veum Square, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "e16293ae-4808-45bd-91bc-ec7040b918a6",
"address1": "321233 Veum Square",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "321233 Veum Square, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "d62629d4-269b-41fd-8fc2-fadf9c38fe20",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"3d0b3b74-c23e-4323-aed0-0334b4bbafe0"
],
"password_recovery_question_ids": [
"bbc8e8a1-7e1a-4c56-a711-75bd95ee9768",
"1376b747-7a78-4c59-a950-827136648159"
]
},
"unit": {
"id": "fc79250b-3123-49ca-a99e-2dcb81c478b7",
"price": 932.14,
"name": "U33",
"description": "",
"width": 2.0,
"length": 8.0,
"height": 3.0,
"door_height": 9.0,
"door_width": 3.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "2x8x3",
"area": 16.0,
"standard_rate": 932.14,
"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": 1956,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
"name": "Unit Type 33",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "2d239503-5d92-45ca-b0c7-288087fef34e"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
"name": "Unit Type 33",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "2d239503-5d92-45ca-b0c7-288087fef34e",
"price": 932.14,
"group_key": "2x8x3 - $932.14 - 2003",
"name": "2x8x3 - $932.14 - 2003",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "2x8x3",
"standard_rate": 932.14,
"floor": null,
"reduced_price": 932.14,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 16.0,
"length": 8.0,
"width": 2.0,
"height": 3.0,
"due_at_move_in": 932.14,
"due_at_move_in_without_fees": 932.14,
"due_monthly": 932.14,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1956,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "c3a1b5aa-23a6-4ee9-af0c-d2dd8d93aab8",
"name": "Unit Type 33",
"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": {
"id": "9d912ac0-0f6e-4219-9199-e6cf67ba4814",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "d62629d4-269b-41fd-8fc2-fadf9c38fe20"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/inquiries
Show all leads that are not reservations (inquiries)
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/b7e9fa70-b2b7-45af-bff7-649f77ecdbbc/leads/inquiries
200
{
"leads": [
{
"id": "69829173-4bdd-4509-a117-a3a5f17b87fc",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:38.292-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:38.272-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:38.292-10:00",
"status": "created",
"tenant_id": "32be1425-3c71-437a-a5ce-b02729ab7916",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "32be1425-3c71-437a-a5ce-b02729ab7916",
"account_number": 1000000,
"first_name": "Sharolyn41",
"last_name": "Wehner",
"middle_initial": null,
"email": "tabalistreri@hirthe.biz41",
"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": "username_41",
"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:38.279-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "7294d4ea-8780-4c5e-adb6-2916c5e8175d",
"address1": "2964015 Bednar Lodge",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2964015 Bednar Lodge, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "7294d4ea-8780-4c5e-adb6-2916c5e8175d",
"address1": "2964015 Bednar Lodge",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2964015 Bednar Lodge, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"44670e82-b6eb-4d51-a08e-e84550ca8803"
],
"password_recovery_question_ids": [
"9011c552-1511-4429-8a62-2d8a90972256",
"69bec83d-1af1-4051-a01d-a7a94e971b1f"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "2f6d4b80-991e-4167-9746-f18e2f350b2d",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "b7e9fa70-b2b7-45af-bff7-649f77ecdbbc"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/missed_move_ins
Show all missed move ins
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/6240e5f5-4b50-4df5-89bb-358f8e8c93f9/leads/missed_move_ins
200
{
"leads": [
{
"id": "86f5c766-4209-4598-b438-b8314a18a907",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-1664",
"created_at": "2022-09-12T22:36:41.042-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": "9x2x1 at $729.01",
"due_at_move_in": 413.11,
"due_monthly": 729.01,
"extra_details": {
"snapshot_reservation_id": "6ea8cec7-6fd4-461d-84cf-c6709c3f84e2"
},
"facility_id": "6240e5f5-4b50-4df5-89bb-358f8e8c93f9",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:41.023-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 729.01,
"rate_type": null,
"reduced_price": 729.01,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2022-09-12T22:36:41.079-10:00",
"size": "9x2x1",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:41.042-10:00",
"status": "reserved",
"tenant_id": "07494169-74bb-4298-968c-81188b25eaf3",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "07494169-74bb-4298-968c-81188b25eaf3",
"account_number": 1000001,
"first_name": "Kieth57",
"last_name": "Wehner",
"middle_initial": null,
"email": "adolph@weber.name57",
"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": "username_57",
"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:41.029-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "8033f1bc-d0b3-425f-a63c-d1fb9e74a312",
"address1": "33739220 Granville Place",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "33739220 Granville Place, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "8033f1bc-d0b3-425f-a63c-d1fb9e74a312",
"address1": "33739220 Granville Place",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "33739220 Granville Place, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "6240e5f5-4b50-4df5-89bb-358f8e8c93f9",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"9d7bf5e4-c475-4fcd-936e-5ea419612316"
],
"password_recovery_question_ids": [
"323fa5b6-7461-495f-98f1-77efb3a8c21c",
"c612ea95-3259-45f2-a54f-fcd841f9440c"
]
},
"unit": {
"id": "d8b42d06-48a4-4a47-8bf5-8a5a72f5e30f",
"price": 729.01,
"name": "U35",
"description": "",
"width": 9.0,
"length": 2.0,
"height": 1.0,
"door_height": 3.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "9x2x1",
"area": 18.0,
"standard_rate": 729.01,
"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": 1958,
"descriptor": "No Tier",
"tiered_amenities": []
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "2bd2bcf5-5655-4550-8c41-6df9a532db59",
"name": "Unit Type 35",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"unit_group_id": "319df09b-6023-4aae-b188-6527b3d5bab5"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "2bd2bcf5-5655-4550-8c41-6df9a532db59",
"name": "Unit Type 35",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "319df09b-6023-4aae-b188-6527b3d5bab5",
"price": 729.01,
"group_key": "9x2x1 - $729.01 - 2005",
"name": "9x2x1 - $729.01 - 2005",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "9x2x1",
"standard_rate": 729.01,
"floor": null,
"reduced_price": 729.01,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 18.0,
"length": 2.0,
"width": 9.0,
"height": 1.0,
"due_at_move_in": 729.01,
"due_at_move_in_without_fees": 729.01,
"due_monthly": 729.01,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": 1958,
"descriptor": "No Tier",
"justification": null,
"tiered_amenities": []
},
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "2bd2bcf5-5655-4550-8c41-6df9a532db59",
"name": "Unit Type 35",
"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": {
"id": "4707521c-724b-4f57-88b1-cad1f070ccac",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
}
],
"meta": {
"pagination": {
"current_page": 1,
"total_pages": 1,
"per_page": 100,
"total_entries": 1,
"previous_page": null,
"next_page": null
},
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "6240e5f5-4b50-4df5-89bb-358f8e8c93f9"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/waitlist
Show all waitlist leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/open/events
Shows all lead events for open leads
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/counts
Shows a count of open leads by status (lead, reservation)
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
GET /v1/:facility_id/leads/:id
Show a particular lead
You can filter leads by channel category. The field channel has these possible values: system, tenant_portal, sales_center, web, print, other, web_popup
Examples
GET /v1/9fa6c459-56ae-47fc-aece-e739f2102c22/leads/ad0332ce-e4d8-4cd1-89c3-57d5278d59c1
200
{
"lead": {
"id": "ad0332ce-e4d8-4cd1-89c3-57d5278d59c1",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:40.474-10:00",
"desired_move_in_date": "2022-09-12",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "9fa6c459-56ae-47fc-aece-e739f2102c22",
"facility_time_zone": "Hawaii",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [],
"kind": "walk_in",
"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-13T22:36:40.450-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2022-09-12T22:36:40.474-10:00",
"status": "created",
"tenant_id": "51091a18-91aa-4974-9e5d-60361c2eb252",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "51091a18-91aa-4974-9e5d-60361c2eb252",
"account_number": 1000000,
"first_name": "Antonia53",
"last_name": "Wehner",
"middle_initial": null,
"email": "doylekutch@skiles.info53",
"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": "username_53",
"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:40.457-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "2a3eb6ab-cf0f-4685-aed8-6d2bf06a7564",
"address1": "328214 Schuppe Inlet",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "328214 Schuppe Inlet, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "2a3eb6ab-cf0f-4685-aed8-6d2bf06a7564",
"address1": "328214 Schuppe Inlet",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "328214 Schuppe Inlet, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "9fa6c459-56ae-47fc-aece-e739f2102c22",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"3ee12abc-1080-4141-9bb1-a204ef65c9f5"
],
"password_recovery_question_ids": [
"4bfa864a-de9d-4c64-bfbc-37fa7ffa4b49",
"28575618-caca-49d6-84a0-2c22d54c5f5a"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "46ac7da1-d7b5-45e6-bd85-08faf7cf61da",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "GET",
"request_id": null,
"parameters": {
"facility_id": "9fa6c459-56ae-47fc-aece-e739f2102c22",
"id": "ad0332ce-e4d8-4cd1-89c3-57d5278d59c1"
}
}
}
Params
| Param name | Description |
|---|---|
|
channel_category optional |
Value: Must be one of: <code>system</code>, <code>tenant_portal</code>, <code>sales_center</code>, <code>web</code>, <code>print</code>, <code>other</code>, <code>web_popup</code>. |
|
id required |
Value: Must be a String |
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 |
POST /v1/:facility_id/leads/rent_now
Create a new lead for a rent-now reservation
This API is to support the "Rent It Now" feature on the CubeSmart.com website.
It sets the rent_now attribute to true and the desired_move_in_date to the current date.
Prerequisites
flipper_fms_rent_nowmust be enabled for the facility or else the request will failis_reservationmust be set to truetenant_idortenant_attributesmust be providedunit_idmust be provided
Examples
POST /v1/54a596cb-08bf-45ac-9a1a-1a2483eb1d3c/leads
{
"lead": {
"is_reservation": "true",
"tenant_attributes": {
"first_name": "Jeff",
"last_name": "Rentnow",
"phone_numbers_attributes": [
{
"number": "5553333333",
"sms_opt_in": "true",
"primary": "true",
"label": "mobile"
}
],
"mailing_address_attributes": {
"address1": "5 Street",
"city": "Malvern",
"state": "PA",
"postal": "19355"
},
"settings_attributes": {
"opt_in_to_transactional_sms": "true"
}
},
"unit_id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330"
},
"payment_method": {
"billing_address_attributes": {
"address1": "Address line 1",
"city": "Melvern",
"country": "US",
"postal": "66510",
"state": "AL"
},
"card_number": "1111111111111111",
"card_type": "visa",
"expiration_date": "10/24",
"first_name": "John",
"kind": "credit_card",
"last_name": "Doe",
"security_code": "123"
}
}
201
{
"lead": {
"id": "0b7ec59f-ec7a-4cf1-8a05-b561831262b1",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "5005929959-1-9437346",
"created_at": "2024-02-12T17:23:18.492-08:00",
"desired_move_in_date": "2024-02-12",
"desired_unit_size_and_price": "5x10x8 at $72.00",
"due_at_move_in": 101.0,
"due_monthly": 72.0,
"extra_details": {
"saved_cyo_options_ids": "[]",
"snapshot_reservation_id": "30123c0e-1542-4f63-9f6b-7d1b2a078ba5",
"move_in_from_reservation_short_url": "https://rental-center.staging.cms.cubesmart.com?companyId=7080ac59-4366-4a77-b425-79071b0b353a&facilityId=eb570f44-5dc7-4a7d-afd7-a6518ba62067&leadId=0b7ec59f-ec7a-4cf1-8a05-b561831262b1"
},
"facility_id": "eb570f44-5dc7-4a7d-afd7-a6518ba62067",
"facility_time_zone": "Pacific Time (US & Canada)",
"floor": null,
"free_truck": false,
"has_paid_reservation_fee": null,
"invoiceable_fees": [
{
"id": "0c57a0ec-a520-4e5a-9529-8eb49ad7d4d5",
"product_code": "ADMINFEE",
"kind": "fee",
"description": "Admin Fee",
"required_at_move_in": true,
"required_at_transfer": false,
"amount": 29.0,
"short_description": null,
"show_in_sales_center": false,
"tax_total": 0.0,
"total": 29.0
}
],
"kind": "internet",
"lead_action_indexes": {},
"length_of_stay_id": null,
"move_in_from_reservation_url": "https://rent-now.cubesmart.com/eb570f44-5dc7-4a7d-afd7-a6518ba62067/0b7ec59f-ec7a-4cf1-8a05-b561831262b1",
"moved_in_at": null,
"moving_labor": false,
"moving_labor_contacted_already": false,
"next_action_at": "2024-02-12T00:00:00.000-08:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "reservation",
"plant_a_tree": false,
"quoted_rate": 72.0,
"rate_type": "standard_rate",
"rent_now": true,
"reduced_price": 72.0,
"reservation_fee_required": null,
"reservation_window": 30,
"reserved_at": "2024-02-12T17:23:18.235-08:00",
"size": "5x10x8",
"source_id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
"source_name": "CubeSmart: App Dev",
"standard_rate": 72.0,
"started_at": "2024-02-12T17:23:18.492-08:00",
"status": "reserved",
"tenant_id": "199670a2-cf10-4a7c-bd77-3d3078468dc8",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "199670a2-cf10-4a7c-bd77-3d3078468dc8",
"account_number": 5005929959,
"first_name": "Jeff",
"last_name": "Rentnow",
"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": true,
"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": "2024-02-12T17:23:18.166-08:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "cf512f53-501b-4040-9c9d-1339d556849b",
"primary": true,
"source": null,
"number": "+15553333333",
"formatted_number": "(555) 333-3333",
"extension": null,
"label": "mobile",
"unformatted_number": "5553333333"
}
],
"mailing_address": {
"id": "a29fd7b4-9197-4924-9cd4-5e4a99555645",
"address1": "5 Street",
"address2": null,
"city": "Malvern",
"state": "PA",
"postal": "19355",
"country": "US",
"full_address": "5 Street, Malvern, PA 19355",
"latitude": null,
"longitude": null,
"time_zone_id": "America/New_York",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "a29fd7b4-9197-4924-9cd4-5e4a99555645",
"address1": "5 Street",
"address2": null,
"city": "Malvern",
"state": "PA",
"postal": "19355",
"country": "US",
"full_address": "5 Street, Malvern, PA 19355",
"latitude": null,
"longitude": null,
"time_zone_id": "America/New_York",
"time_zone_offset": "-05:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "eb570f44-5dc7-4a7d-afd7-a6518ba62067",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"0c3d2d41-0b8a-4478-8cfa-0429b831f429"
],
"password_recovery_question_ids": []
},
"unit": {
"id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330",
"price": 72.0,
"name": "H236",
"description": "(HEE) - Air cooled (swamp cooled) only / Heated only, Economy Pricing, Upstairs access via elevator",
"width": 5.0,
"length": 10.0,
"height": 8.0,
"door_height": 6.0,
"door_width": 3.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "5x10x8",
"area": 50.0,
"standard_rate": 72.0,
"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": {
"id": 60694,
"name": "Prepped",
"combo_code": " ",
"facility_id": 17398,
"created_at": "2023-11-15T15:39:45.280-08:00",
"updated_at": "2023-11-15T15:39:45.280-08:00"
},
"combination_lock_number": null,
"overlock_lock_number": null,
"attribute_description": "HEE",
"deleted": false,
"damaged": false,
"complimentary": null,
"unrentable": false,
"company_owned": false,
"is_prepped": true,
"tiering": {
"cross_sell_group_id": "502b7398-32ae-4f5e-8c1c-f82c517e6381",
"descriptor": "Economy Pricing",
"tiered_amenities": [
"59ba10f6-4083-46aa-a588-4c70b236c584"
]
},
"custom_fields": [],
"channel_rate": null,
"unit_amenities": [
{
"id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
"name": "Air cooled (swamp cooled) only / Heated only",
"short_code": "H",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 5
},
{
"id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
"name": "Upstairs access via elevator",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 21
},
{
"id": "59ba10f6-4083-46aa-a588-4c70b236c584",
"name": "Economy Pricing",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 85
}
],
"unit_type": {
"id": "94385936-5500-4b12-bb14-6d4b425b80b8",
"name": "Storage",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": [],
"commercial": false
},
"unit_group_id": "0c647fd9-c3ee-4824-8fe3-d8247bf6f635"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [
{
"id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
"name": "Air cooled (swamp cooled) only / Heated only",
"short_code": "H",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 5
},
{
"id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
"name": "Upstairs access via elevator",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 21
},
{
"id": "59ba10f6-4083-46aa-a588-4c70b236c584",
"name": "Economy Pricing",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 85
}
],
"current_user": null,
"unit_type": {
"id": "94385936-5500-4b12-bb14-6d4b425b80b8",
"name": "Storage",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": [],
"commercial": false
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "0c647fd9-c3ee-4824-8fe3-d8247bf6f635",
"price": 72.0,
"group_key": "5x10x8 - $72.00 - 2 - [5 - 21 - 85]",
"name": "5x10x8 - $72.00 - 2 - [5 - 21 - 85]",
"available_units_count": 0,
"total_units_count": 50,
"total_non_excluded_units_count": 50,
"size": "5x10x8",
"standard_rate": 72.0,
"floor": null,
"reduced_price": 54.0,
"cyo_reduced_prices": {},
"occupancy_percent": 98.0,
"area": 50.0,
"length": 10.0,
"width": 5.0,
"height": 8.0,
"due_at_move_in": 83.0,
"due_at_move_in_without_fees": 54.0,
"due_monthly": 54.0,
"attribute_description": "HEE",
"description": "(HEE) - Air cooled (swamp cooled) only / Heated only, Economy Pricing, Upstairs access via elevator",
"invoiceable_fees": [
{
"id": "0c57a0ec-a520-4e5a-9529-8eb49ad7d4d5",
"product_code": "ADMINFEE",
"kind": "fee",
"description": "Admin Fee",
"required_at_move_in": true,
"required_at_transfer": false,
"amount": 29.0,
"short_description": null,
"show_in_sales_center": false,
"tax_total": 0.0,
"total": 29.0
}
],
"average_rent": 106.53,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"tiering": {
"cross_sell_group_id": "502b7398-32ae-4f5e-8c1c-f82c517e6381",
"descriptor": "Economy Pricing",
"justification": null,
"tiered_amenities": [
"59ba10f6-4083-46aa-a588-4c70b236c584"
]
},
"channel_rate": null,
"unit_amenities": [
{
"id": "8628f2b3-2fe6-44ee-a3f7-918c7886181f",
"name": "Air cooled (swamp cooled) only / Heated only",
"short_code": "H",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 5
},
{
"id": "41d36c49-e5cb-4909-82f9-7e2809a2884c",
"name": "Upstairs access via elevator",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 21
},
{
"id": "59ba10f6-4083-46aa-a588-4c70b236c584",
"name": "Economy Pricing",
"short_code": "E",
"show_in_sales_center_filter_dropdown": false,
"deleted": false,
"primary_key_id": 85
}
],
"unit_type": {
"id": "94385936-5500-4b12-bb14-6d4b425b80b8",
"name": "Storage",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": [],
"commercial": false
},
"discount_plans": [],
"channel_rate_ids": [],
"available_upgrade_to_unit_groups": []
},
"created_by": {
"id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
"name": "CubeSmart: App Dev",
"type": "Source"
},
"channel_id": "af971b52-b3ad-40b5-93da-e0cd32d24c6f",
"confirmation_email": null
},
"meta": {
"status_code": 201,
"status_message": "Created",
"status_cat": "https://http.cat/201",
"request_method": "POST",
"request_id": "88f932c8-5c86-42b6-90ef-75d356109e68",
"parameters": {
"lead": {
"is_reservation": "true",
"tenant_attributes": {
"first_name": "Jeff",
"last_name": "Rentnow",
"phone_numbers_attributes": [
{
"number": "5553333333",
"sms_opt_in": "true",
"primary": "true",
"label": "mobile"
}
],
"mailing_address_attributes": {
"address1": "5 Street",
"city": "Malvern",
"state": "PA",
"postal": "19355"
},
"settings_attributes": {
"opt_in_to_transactional_sms": "true"
}
},
"unit_id": "c6a67bf8-6d7e-4e7f-a488-cda17bd03330"
},
"payment_method": {
"billing_address_attributes": {
"address1": "Address line 1",
"city": "Melvern",
"country": "US",
"postal": "66510",
"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": "eb570f44-5dc7-4a7d-afd7-a6518ba62067"
}
}
}
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 |
PUT /v1/:facility_id/leads/:id
Update an existing lead
Examples
PUT /v1/81f0e949-1006-4b75-89c5-a80023d8218d/leads/568a340f-b063-4c97-98fe-99bffa231a96
{
"lead": {
"desired_move_in_date": "2022-09-14",
"notes_attributes": [
{
"note": "A shorter note"
}
],
"tenant_attributes": {
"first_name": "Joseph"
}
}
}
200
{
"lead": {
"id": "568a340f-b063-4c97-98fe-99bffa231a96",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2022-09-12T22:36:37.133-10:00",
"desired_move_in_date": "2022-09-14",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "81f0e949-1006-4b75-89c5-a80023d8218d",
"facility_time_zone": "Hawaii",
"floor": 2,
"free_truck": false,
"has_paid_reservation_fee": null,
"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": "lead",
"plant_a_tree": false,
"quoted_rate": null,
"rate_type": null,
"reduced_price": null,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": null,
"size": null,
"source_id": "46c87555-dcf8-4219-b9b7-063a6095ade1",
"source_name": "Test App",
"standard_rate": null,
"started_at": "2022-09-12T22:36:37.133-10:00",
"status": "created",
"tenant_id": "6757bbfc-107b-43ca-aac2-4e9b967c088b",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "6757bbfc-107b-43ca-aac2-4e9b967c088b",
"account_number": 1000000,
"first_name": "Joseph",
"last_name": "Wehner",
"middle_initial": null,
"email": "frankietrantow@stracke.io35",
"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": "username_35",
"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:37.118-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [],
"mailing_address": {
"id": "9b57cf3a-6898-4b3f-9773-93089a726413",
"address1": "2802629 Barrows Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2802629 Barrows Turnpike, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "9b57cf3a-6898-4b3f-9773-93089a726413",
"address1": "2802629 Barrows Turnpike",
"address2": null,
"city": "South Jessie",
"state": "CT",
"postal": "39384",
"country": "US",
"full_address": "2802629 Barrows Turnpike, South Jessie, CT 39384",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "81f0e949-1006-4b75-89c5-a80023d8218d",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"9d667560-cf84-465e-963d-ee1729013bec",
"7b91e5d6-62fb-48f3-beb2-e2c685923c43"
],
"password_recovery_question_ids": [
"a81ee65f-0494-4022-aa8d-9638ee448eb5",
"1749c245-ae7a-4dfe-b3bf-b520b0d4d869"
]
},
"unit": null,
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": null,
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": null,
"created_by": {
"id": "46c87555-dcf8-4219-b9b7-063a6095ade1",
"name": "Test App",
"type": "Source"
},
"channel_id": "46c87555-dcf8-4219-b9b7-063a6095ade1",
"confirmation_email": null
},
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "PUT",
"request_id": null,
"parameters": {
"lead": {
"desired_move_in_date": "2022-09-14",
"notes_attributes": [
{
"note": "A shorter note"
}
],
"tenant_attributes": {
"first_name": "Joseph"
}
},
"facility_id": "81f0e949-1006-4b75-89c5-a80023d8218d",
"id": "568a340f-b063-4c97-98fe-99bffa231a96"
}
}
}
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 |
DELETE /v1/:facility_id/leads/:id
Destroy a lead
Examples
DELETE /v1/2ca8aac2-917a-49aa-892b-c59637e29306/leads/8d155e30-a65b-45e9-ae72-c423e4c1cdc5
{
"lead": {
"close_reason_id": "39bbc8c0-0edb-4ce7-9e73-3e006eebabb7",
"notes_attributes": [
{
"note": "A++ would rent again!"
}
]
}
}
200
{
"meta": {
"status_code": 200,
"status_message": "OK",
"status_cat": "https://http.cat/200",
"request_method": "DELETE",
"request_id": null,
"parameters": {
"lead": {
"close_reason_id": "39bbc8c0-0edb-4ce7-9e73-3e006eebabb7",
"notes_attributes": [
{
"note": "A++ would rent again!"
}
]
},
"facility_id": "2ca8aac2-917a-49aa-892b-c59637e29306",
"id": "8d155e30-a65b-45e9-ae72-c423e4c1cdc5"
}
}
}
Params
| Param name | Description |
|---|---|
|
id required |
Value: Must be a String |