Leads (Facility Level)
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. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/81926459-9d09-4862-a7ad-3279f3a71b8b/leads
200
{
"leads": [
{
"id": "215d6043-1122-4141-b0cd-c58c67eb2f0b",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2700",
"created_at": "2023-09-15T04:38:06.582-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "9x5x4 at $926.12",
"due_at_move_in": 432.19,
"due_monthly": 926.12,
"extra_details": {
"snapshot_reservation_id": "042fffbf-7417-4446-9b07-47ee778e649c"
},
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"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": "2023-09-16T04:38:06.549-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 926.12,
"rate_type": null,
"reduced_price": 926.12,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:06.664-10:00",
"size": "9x5x4",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:06.582-10:00",
"status": "reserved",
"tenant_id": "6ce5a49c-0ce7-4f8f-b32b-3f39e02ec204",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "6ce5a49c-0ce7-4f8f-b32b-3f39e02ec204",
"account_number": 1000001,
"first_name": "Noemi128",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_128",
"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": "2023-09-15T04:38:06.562-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": "22a170b8-f9ca-42e2-a8a1-741833b96803",
"address1": "76542754 Wilfredo Club",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "76542754 Wilfredo Club, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "22a170b8-f9ca-42e2-a8a1-741833b96803",
"address1": "76542754 Wilfredo Club",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "76542754 Wilfredo Club, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"925d9cb3-c5ed-4791-a595-af8e4057c870"
],
"password_recovery_question_ids": [
"9a973688-33fb-496f-ad8a-55f1e915e419",
"5a7fce44-b6ff-464b-80a4-e333dae07f79"
]
},
"unit": {
"id": "3816382c-ca46-4ea5-89ee-f74dc5e22511",
"price": 926.12,
"name": "U85",
"description": "",
"width": 9.0,
"length": 5.0,
"height": 4.0,
"door_height": 9.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "9x5x4",
"area": 45.0,
"standard_rate": 926.12,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "aa33a8eb-55a8-4659-b922-39b380d72445"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "aa33a8eb-55a8-4659-b922-39b380d72445",
"price": 926.12,
"group_key": "9x5x4 - $926.12 - 3195",
"name": "U85 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "9x5x4",
"standard_rate": 926.12,
"floor": null,
"reduced_price": 926.12,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 45.0,
"length": 5.0,
"width": 9.0,
"height": 4.0,
"due_at_move_in": 926.12,
"due_at_move_in_without_fees": 926.12,
"due_monthly": 926.12,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "01108e7c-984b-41f1-809f-8e9e8265e80e",
"name": "Unit Type 108",
"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": "4534d050-eb3e-4e4c-9ec1-a8d7a92e0914",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "eb5f0a64-cd43-4743-bde8-7f80673a7d9c",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:06.509-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"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": "2023-09-16T04:38:06.477-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": "2023-09-15T04:38:06.509-10:00",
"status": "created",
"tenant_id": "cc00bc8a-b4de-4945-a144-4e8b49ba5314",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "cc00bc8a-b4de-4945-a144-4e8b49ba5314",
"account_number": 1000000,
"first_name": "Verena127",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_127",
"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": "2023-09-15T04:38:06.489-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": "a8f6e8c6-9121-48cc-9f77-0b80edc16429",
"address1": "764684 Heidenreich Rest",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "764684 Heidenreich Rest, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "a8f6e8c6-9121-48cc-9f77-0b80edc16429",
"address1": "764684 Heidenreich Rest",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "764684 Heidenreich Rest, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"3d35ce4a-91ce-4609-9df1-e440d02ee632"
],
"password_recovery_question_ids": [
"62b938d5-10fd-4072-abc5-3b298f232715",
"63df17d2-61b1-4e9b-9117-50df337a15a0"
]
},
"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": "4534d050-eb3e-4e4c-9ec1-a8d7a92e0914",
"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": "81926459-9d09-4862-a7ad-3279f3a71b8b",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/current
Show all current leads
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/14f928d2-02b0-4410-bdf1-7104b5c28b73/leads/current
200
{
"leads": [
{
"id": "518d9d71-52dc-448a-8e1c-83d3371af38e",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2688",
"created_at": "2023-09-15T04:38:02.425-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "5x9x3 at $848.50",
"due_at_move_in": 395.97,
"due_monthly": 848.5,
"extra_details": {
"snapshot_reservation_id": "99e4cfc6-2ddf-49e8-b74d-ff83737af7a7"
},
"facility_id": "14f928d2-02b0-4410-bdf1-7104b5c28b73",
"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": "2023-09-16T04:38:02.394-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 848.5,
"rate_type": null,
"reduced_price": 848.5,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:02.491-10:00",
"size": "5x9x3",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:02.425-10:00",
"status": "reserved",
"tenant_id": "7c08741d-ebc7-439c-820c-9bc08320acd4",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "7c08741d-ebc7-439c-820c-9bc08320acd4",
"account_number": 1000001,
"first_name": "Bong116",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_116",
"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": "2023-09-15T04:38:02.407-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": "5f31b330-5d79-4f2b-8a28-df27ad8a14b7",
"address1": "733846 O'Reilly Stravenue",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "733846 O'Reilly Stravenue, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "5f31b330-5d79-4f2b-8a28-df27ad8a14b7",
"address1": "733846 O'Reilly Stravenue",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "733846 O'Reilly Stravenue, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "14f928d2-02b0-4410-bdf1-7104b5c28b73",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"2c3c5092-6819-4a60-bab6-63920704f81c"
],
"password_recovery_question_ids": [
"77796d2c-52d7-4c9a-93cf-82fdc883cd30",
"300c6e61-87ec-479a-a4a5-aa25794360d9"
]
},
"unit": {
"id": "4995c9c7-f401-4f77-8b77-78fca1925ebe",
"price": 848.5,
"name": "U81",
"description": "",
"width": 5.0,
"length": 9.0,
"height": 3.0,
"door_height": 8.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "5x9x3",
"area": 45.0,
"standard_rate": 848.5,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "834b613a-33e7-4f72-b3c6-28a72dc771ff",
"name": "Unit Type 104",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "12aaae4e-0a21-4279-b623-da4f8ae66278"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "834b613a-33e7-4f72-b3c6-28a72dc771ff",
"name": "Unit Type 104",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "12aaae4e-0a21-4279-b623-da4f8ae66278",
"price": 848.5,
"group_key": "5x9x3 - $848.50 - 3191",
"name": "U81 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "5x9x3",
"standard_rate": 848.5,
"floor": null,
"reduced_price": 848.5,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 45.0,
"length": 9.0,
"width": 5.0,
"height": 3.0,
"due_at_move_in": 848.5,
"due_at_move_in_without_fees": 848.5,
"due_monthly": 848.5,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "834b613a-33e7-4f72-b3c6-28a72dc771ff",
"name": "Unit Type 104",
"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": "9d06ae60-f7df-4fe5-be56-466b856f8f47",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "36b1c260-d262-40a6-8049-189cd320c270",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:02.361-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "14f928d2-02b0-4410-bdf1-7104b5c28b73",
"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": "2023-09-16T04:38:02.329-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": "2023-09-15T04:38:02.361-10:00",
"status": "created",
"tenant_id": "14747d37-7c8a-42a4-8170-33306afba802",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "14747d37-7c8a-42a4-8170-33306afba802",
"account_number": 1000000,
"first_name": "Stevie115",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_115",
"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": "2023-09-15T04:38:02.341-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": "2b966b17-a43a-427a-b0d8-876c0d1450ba",
"address1": "7321138 Hegmann Walks",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7321138 Hegmann Walks, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "2b966b17-a43a-427a-b0d8-876c0d1450ba",
"address1": "7321138 Hegmann Walks",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7321138 Hegmann Walks, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "14f928d2-02b0-4410-bdf1-7104b5c28b73",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"a271d900-8c89-41b1-b6dc-643475b37d8c"
],
"password_recovery_question_ids": [
"0cc5f179-c3a2-4788-a324-aff123ad9398",
"e9075101-e01a-4484-89a0-38c9aa7efc69"
]
},
"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": "9d06ae60-f7df-4fe5-be56-466b856f8f47",
"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": "14f928d2-02b0-4410-bdf1-7104b5c28b73",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/follow_up
Show all followup leads
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/7997dc10-9896-4123-b450-e5fb751fee08/leads/follow_up
200
{
"leads": [
{
"id": "ffe70566-53d6-474b-833e-3aba3b32683a",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2703",
"created_at": "2023-09-15T04:38:07.766-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "4x4x4 at $30.38",
"due_at_move_in": 14.18,
"due_monthly": 30.38,
"extra_details": {
"snapshot_reservation_id": "a8585629-1b55-4068-8769-f96b8380a9a4"
},
"facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
"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": "2023-09-16T04:38:07.739-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 30.38,
"rate_type": null,
"reduced_price": 30.38,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:07.824-10:00",
"size": "4x4x4",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:07.767-10:00",
"status": "reserved",
"tenant_id": "fc6982c3-abe9-49cc-b3f0-bb2d5abf1b2e",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "fc6982c3-abe9-49cc-b3f0-bb2d5abf1b2e",
"account_number": 1000001,
"first_name": "Sean131",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_131",
"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": "2023-09-15T04:38:07.748-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": "c797512e-3470-44a6-8875-037b00137c66",
"address1": "7739337 Federico Spurs",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7739337 Federico Spurs, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "c797512e-3470-44a6-8875-037b00137c66",
"address1": "7739337 Federico Spurs",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7739337 Federico Spurs, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"453e1653-298d-4f85-a280-63262a7af9aa"
],
"password_recovery_question_ids": [
"6a401822-1e60-471c-ac24-fe0f314e514f",
"38d42fbe-f355-4d14-a168-a0b1d2af9914"
]
},
"unit": {
"id": "c4a867b9-ed7a-4c37-b3be-2d00c874bd6d",
"price": 30.38,
"name": "U86",
"description": "",
"width": 4.0,
"length": 4.0,
"height": 4.0,
"door_height": 1.0,
"door_width": 3.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "4x4x4",
"area": 16.0,
"standard_rate": 30.38,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
"name": "Unit Type 109",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "0a21493e-4d42-43cd-8973-60e3f1f6a5b5"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
"name": "Unit Type 109",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "0a21493e-4d42-43cd-8973-60e3f1f6a5b5",
"price": 30.38,
"group_key": "4x4x4 - $30.38 - 3196",
"name": "U86 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "4x4x4",
"standard_rate": 30.38,
"floor": null,
"reduced_price": 30.38,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 16.0,
"length": 4.0,
"width": 4.0,
"height": 4.0,
"due_at_move_in": 30.38,
"due_at_move_in_without_fees": 30.38,
"due_monthly": 30.38,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "40101a17-fb4c-425a-b62d-067c0eddf8a2",
"name": "Unit Type 109",
"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": "cbf19bc9-3a26-447b-9c8e-7ff352fde6b1",
"name": "Test App",
"type": "Source"
},
"channel_id": null,
"confirmation_email": null
},
{
"id": "82f65ed6-96eb-4795-90b7-fb6d08375951",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:07.714-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
"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": "2023-09-16T04:38:07.684-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": "2023-09-15T04:38:07.714-10:00",
"status": "created",
"tenant_id": "32db6e3a-2558-40dd-8b22-38a35c20b9a8",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "32db6e3a-2558-40dd-8b22-38a35c20b9a8",
"account_number": 1000000,
"first_name": "Chanda130",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_130",
"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": "2023-09-15T04:38:07.694-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": "aaee2eca-ba3e-455a-948e-7b7828dad74c",
"address1": "7723668 Rashad Junction",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7723668 Rashad Junction, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "aaee2eca-ba3e-455a-948e-7b7828dad74c",
"address1": "7723668 Rashad Junction",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "7723668 Rashad Junction, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "7997dc10-9896-4123-b450-e5fb751fee08",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"c66b7a1a-77ab-431d-8a3b-776b2c34317c"
],
"password_recovery_question_ids": [
"8be7381e-8947-40f1-9183-537ff3be8007",
"19beb50d-c5fb-496e-9b73-45d710088094"
]
},
"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": "cbf19bc9-3a26-447b-9c8e-7ff352fde6b1",
"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": "7997dc10-9896-4123-b450-e5fb751fee08",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/reservations
Show all leads that are reservations
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/de9e68eb-ae53-43e8-b450-4481e6fa70c7/leads/reservations
200
{
"leads": [
{
"id": "7d58f4bb-ada5-4a3f-af27-30c2e9889a78",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2694",
"created_at": "2023-09-15T04:38:04.714-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "10x6x8 at $537.73",
"due_at_move_in": 250.94,
"due_monthly": 537.73,
"extra_details": {
"snapshot_reservation_id": "c9b5a60f-0c68-48e0-96f3-2bed2b0b997f"
},
"facility_id": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"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": "2023-09-16T04:38:04.680-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 537.73,
"rate_type": null,
"reduced_price": 537.73,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:04.782-10:00",
"size": "10x6x8",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:04.714-10:00",
"status": "reserved",
"tenant_id": "8184b01c-7c17-4c55-a1d6-ece9f947fd69",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "8184b01c-7c17-4c55-a1d6-ece9f947fd69",
"account_number": 1000001,
"first_name": "Juliana122",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_122",
"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": "2023-09-15T04:38:04.694-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": "c143752c-2bd0-4685-9c1b-53abc43a2cda",
"address1": "74991904 Treutel Ferry",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "74991904 Treutel Ferry, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "c143752c-2bd0-4685-9c1b-53abc43a2cda",
"address1": "74991904 Treutel Ferry",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "74991904 Treutel Ferry, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"e69713ad-ddc3-4b44-8dd3-4cdbf0dd4371"
],
"password_recovery_question_ids": [
"f0e59f3d-012d-48b3-84dd-36730c79219a",
"037bef8e-de63-4f10-97fc-b139cb90a2d4"
]
},
"unit": {
"id": "7cd03be5-d816-43f6-b702-0117ec75dc91",
"price": 537.73,
"name": "U83",
"description": "",
"width": 10.0,
"length": 6.0,
"height": 8.0,
"door_height": 2.0,
"door_width": 4.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x6x8",
"area": 60.0,
"standard_rate": 537.73,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "e609b386-96c3-4366-9a32-804126311868"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "e609b386-96c3-4366-9a32-804126311868",
"price": 537.73,
"group_key": "10x6x8 - $537.73 - 3193",
"name": "U83 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "10x6x8",
"standard_rate": 537.73,
"floor": null,
"reduced_price": 537.73,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 60.0,
"length": 6.0,
"width": 10.0,
"height": 8.0,
"due_at_move_in": 537.73,
"due_at_move_in_without_fees": 537.73,
"due_monthly": 537.73,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "3a229d9c-76ea-413e-9ba5-5b6425fefa6d",
"name": "Unit Type 106",
"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": "f6a65880-c14e-43bf-bb77-591980e1192e",
"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": "de9e68eb-ae53-43e8-b450-4481e6fa70c7",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/inquiries
Show all leads that are not reservations (inquiries)
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/da56c2ff-9071-4c18-acc8-5a9ef4657270/leads/inquiries
200
{
"leads": [
{
"id": "e6a966ca-0952-4b06-a4d8-198dfcfdb55c",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:05.578-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "da56c2ff-9071-4c18-acc8-5a9ef4657270",
"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": "2023-09-16T04:38:05.544-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": "2023-09-15T04:38:05.578-10:00",
"status": "created",
"tenant_id": "170f3027-c7e5-49d3-9cc7-10ad67a1b5fe",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "170f3027-c7e5-49d3-9cc7-10ad67a1b5fe",
"account_number": 1000000,
"first_name": "Earl124",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_124",
"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": "2023-09-15T04:38:05.561-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": "a9518dc1-68e7-4925-8aa9-e157d2b09be7",
"address1": "75616672 Jaye Ridges",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "75616672 Jaye Ridges, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "a9518dc1-68e7-4925-8aa9-e157d2b09be7",
"address1": "75616672 Jaye Ridges",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "75616672 Jaye Ridges, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "da56c2ff-9071-4c18-acc8-5a9ef4657270",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"6ad258a8-6843-45fb-ac5f-20078abff38e"
],
"password_recovery_question_ids": [
"fbf3a4ef-4e7a-4b2f-914f-26a2ca91371e",
"b1e7283e-dcf1-4139-9780-48a2be81c208"
]
},
"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": "98e8f152-3655-4577-bf54-e4cbf965b9dc",
"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": "da56c2ff-9071-4c18-acc8-5a9ef4657270",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/missed_move_ins
Show all missed move ins
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
Examples
GET /v1/18349cbb-1da8-41be-9886-6bc8f6712897/leads/missed_move_ins
200
{
"leads": [
{
"id": "ae1036e1-ef06-4462-ae36-be485be38130",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000001-1-2691",
"created_at": "2023-09-15T04:38:03.684-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "10x3x7 at $31.39",
"due_at_move_in": 14.65,
"due_monthly": 31.39,
"extra_details": {
"snapshot_reservation_id": "97b37b16-bb5c-49e2-8af0-941b1952e811"
},
"facility_id": "18349cbb-1da8-41be-9886-6bc8f6712897",
"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": "2023-09-16T04:38:03.650-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "lead",
"plant_a_tree": false,
"quoted_rate": 31.39,
"rate_type": null,
"reduced_price": 31.39,
"reservation_fee_required": null,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:38:03.747-10:00",
"size": "10x3x7",
"source_id": null,
"source_name": null,
"standard_rate": null,
"started_at": "2023-09-15T04:38:03.684-10:00",
"status": "reserved",
"tenant_id": "40823737-8b88-4778-9ce6-0990dd082dee",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "40823737-8b88-4778-9ce6-0990dd082dee",
"account_number": 1000001,
"first_name": "Justin119",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_119",
"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": "2023-09-15T04:38:03.664-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": "7f2fc90f-c57f-4015-9834-3125bbb4f4b1",
"address1": "741435 Ward Drive",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "741435 Ward Drive, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "7f2fc90f-c57f-4015-9834-3125bbb4f4b1",
"address1": "741435 Ward Drive",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "741435 Ward Drive, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "18349cbb-1da8-41be-9886-6bc8f6712897",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"ad770f22-e854-4f77-ab79-3ee49fc90dd7"
],
"password_recovery_question_ids": [
"4aa58c05-aa4f-4ebd-a517-7846e748ba83",
"bf5291be-32bf-46a1-95dd-8916c491482c"
]
},
"unit": {
"id": "6eb8b9f7-82f6-4295-aff4-2ddb148879dd",
"price": 31.39,
"name": "U82",
"description": "",
"width": 10.0,
"length": 3.0,
"height": 7.0,
"door_height": 3.0,
"door_width": 2.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "10x3x7",
"area": 30.0,
"standard_rate": 31.39,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "5d5e453d-8c45-4751-87df-fadb5ffacfcc",
"name": "Unit Type 105",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "4b5df1ba-7fb1-4a20-ba50-828bc41cc574"
},
"length_of_stay": null,
"successful_payment_events": [],
"caller_phone_number": null,
"unit_amenities": [],
"current_user": null,
"unit_type": {
"id": "5d5e453d-8c45-4751-87df-fadb5ffacfcc",
"name": "Unit Type 105",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "4b5df1ba-7fb1-4a20-ba50-828bc41cc574",
"price": 31.39,
"group_key": "10x3x7 - $31.39 - 3192",
"name": "U82 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "10x3x7",
"standard_rate": 31.39,
"floor": null,
"reduced_price": 31.39,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 30.0,
"length": 3.0,
"width": 10.0,
"height": 7.0,
"due_at_move_in": 31.39,
"due_at_move_in_without_fees": 31.39,
"due_monthly": 31.39,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": null,
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "5d5e453d-8c45-4751-87df-fadb5ffacfcc",
"name": "Unit Type 105",
"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": "74442ab1-c210-4262-950d-d5e0dca325ba",
"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": "18349cbb-1da8-41be-9886-6bc8f6712897",
"lead": {}
}
}
}
GET /v1/:facility_id/leads/waitlist
Show all waitlist leads
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
GET /v1/:facility_id/leads/open/events
Shows all lead events for open leads
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
GET /v1/:facility_id/leads/counts
Shows a count of open leads by status (lead, reservation)
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
GET /v1/:facility_id/leads/:id
Show a particular lead
You can filter leads by channel category. #### Allowed values for channel
* other
* print
* sales_center
* system
* tenant_portal
* web
* web_popup
Params
| Param name | Description |
|---|---|
|
channel_category
optional |
Validations:
|
|
id
required |
Validations:
|
Examples
GET /v1/305ff03a-aead-4712-a336-fa4fa0c187d8/leads/f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4
200
{
"lead": {
"id": "f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:01.449-10:00",
"desired_move_in_date": "2023-09-15",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "305ff03a-aead-4712-a336-fa4fa0c187d8",
"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": "2023-09-16T04:38:01.423-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": "2023-09-15T04:38:01.449-10:00",
"status": "created",
"tenant_id": "cf9b14a7-fced-4850-8b1f-798ce0bb21eb",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "cf9b14a7-fced-4850-8b1f-798ce0bb21eb",
"account_number": 1000000,
"first_name": "Cary112",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_112",
"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": "2023-09-15T04:38:01.433-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": "f34fec33-028d-444d-b31f-cd389f4e47ab",
"address1": "724989 Beier Meadows",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "724989 Beier Meadows, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "f34fec33-028d-444d-b31f-cd389f4e47ab",
"address1": "724989 Beier Meadows",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "724989 Beier Meadows, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "305ff03a-aead-4712-a336-fa4fa0c187d8",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"9e0b1e7f-9428-46e6-b3cb-916d47fcc829"
],
"password_recovery_question_ids": [
"f2c1bb50-38cb-4e95-a226-64882829c346",
"cdf9d137-8071-4104-8747-945353f263a4"
]
},
"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": "0681a433-d3b7-4f26-ae59-0b34171751ee",
"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": "305ff03a-aead-4712-a336-fa4fa0c187d8",
"id": "f6d8ffc1-09c7-4c95-8bc8-68fe2bbfe6a4",
"lead": {}
}
}
}
POST /v1/:facility_id/leads
Create a new lead
Params
| Param name | Description |
|---|---|
|
lead
required |
Validations:
|
|
lead[tenant_id]
optional |
A tenant record to associate the lead with. Required if Validations:
|
|
lead[tenant_attributes]
optional |
Attributes to create a tenant record. Required if Validations:
|
|
lead[tenant_attributes][title]
optional |
Validations:
|
|
lead[tenant_attributes][first_name]
required |
Validations:
|
|
lead[tenant_attributes][last_name]
optional |
Validations:
|
|
lead[tenant_attributes][middle_initial]
optional |
Validations:
|
|
lead[tenant_attributes][last_name]
optional |
Validations:
|
|
lead[tenant_attributes][email]
optional |
Validations:
|
|
lead[tenant_attributes][is_military]
optional |
True if the tenant record is a in the military. Validations:
|
|
lead[tenant_attributes][is_business]
optional |
True if the tenant record is a commercial entity. Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes]
required |
A collection of phone numbers. At least one is required. Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][number]
required |
Phone number Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
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. Validations:
|
|
lead[tenant_attributes][mailing_address_attributes]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][address1]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][address2]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][city]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][state]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][postal]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][time_zone]
optional |
Valid IANA timezone identifier of the address (see http://www.iana.org/time-zones) Validations:
|
|
lead[unit_id]
optional |
The ID of the unit to reserve. Required if Validations:
|
|
lead[online_move_in_url]
optional |
The URL the lead can use to complete the move in Validations:
|
|
lead[id]
optional |
The ID of the lead (update only). Validations:
|
|
lead[is_reservation]
required |
Is the lead a reservation? Validations:
|
|
lead[caller_first_name]
optional |
First name of the caller, if different from the tenant Validations:
|
|
lead[caller_last_name]
optional |
Last name of the caller, if different from the tenant Validations:
|
|
lead[urgent]
optional |
Validations:
|
|
lead[quoted_rate]
optional |
Validations:
|
|
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. Validations:
|
|
lead[size]
optional |
Validations:
|
|
lead[floor]
optional |
Validations:
|
|
lead[lead_contents]
optional |
A collection of marketing content. Validations:
|
|
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. Validations:
|
|
lead[desired_move_in_date]
optional |
Format: YYYY-MM-DD Validations:
|
|
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. Validations:
|
|
lead[free_truck]
optional |
Interested in a free truck Validations:
|
|
lead[moving_labor]
optional |
Interested in having help with moving Validations:
|
|
lead[call_source]
optional |
Where the call was initiated from Validations:
|
|
lead[dnis]
optional |
An identifier for the facility the lead was trying to reach - see http://en.wikipedia.org/wiki/Dialed_Number_Identification_Service Validations:
|
|
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. Validations:
|
|
lead[lead_action_performed]
optional |
The kind of action that was performed on the lead Validations:
|
|
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) Validations:
|
|
lead[next_lead_action]
optional |
The kind of follow up action that will be performed Validations:
|
|
lead[notes_attributes]
optional |
A collection of notes. Validations:
|
|
lead[notes_attributes][note]
required |
Note body - freeform text Validations:
|
|
lead[caller_phone_number_attributes]
required |
Phone number of the caller, if different from the tenant Validations:
|
|
lead[caller_phone_number_attributes][number]
required |
Phone number Validations:
|
|
lead[caller_phone_number_attributes][extension]
optional |
Phone number extension Validations:
|
|
lead[caller_phone_number_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
lead[rate_type]
optional |
The type of rate for the unit (ie. Validations:
|
|
lead[discount_plans]
optional |
Must be an array of nested discount plan ids Validations:
|
|
lead[discount_plans][id]
optional |
The ID of the discount plan to apply. Validations:
|
|
lead[payment_method]
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
lead[payment_method][payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
lead[payment_method][first_name]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][last_name]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][kind]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][reuseable]
optional |
Validations:
|
|
lead[payment_method][magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
lead[payment_method][card_number]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][card_type]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][security_code]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
lead[payment_method][account_number]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][account_type]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][bank_name]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][routing_number]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][billing_address_attributes][company]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][address1]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][address2]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][city]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][postal]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][state]
optional |
Validations:
|
|
lead[payment_method][check_number]
optional |
Required if using Check Validations:
|
|
lead[payment_method][name_on_check]
optional |
Required if using Check Validations:
|
|
lead[payment_method][check_amount]
optional |
Required if using Check Validations:
|
|
lead[payment_method][reference_number]
optional |
Required if using Money Order Validations:
|
|
lead[payment_method][money_order_amount]
optional |
Required if using Money Order Validations:
|
|
lead[payment_method][amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
POST /v1/1858c9ad-4abc-4e1c-98ad-30ed99fa4586/leads
{
"payment_method": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"card_type": "visa",
"card_number": "00000000",
"security_code": "123",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"lead": {
"is_reservation": true,
"desired_move_in_date": "2023-09-17",
"unit_id": "c473f996-6caa-4a2e-9337-df4d684f4d19",
"tenant_attributes": {
"first_name": "John",
"phone_numbers_attributes": [
{
"number": "3333333333",
"sms_opt_in": true
}
]
}
}
}
201
{
"lead": {
"id": "4ff47eba-fbf2-4fde-83d4-8c5e43b1e013",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": "1000003-1-2680",
"created_at": "2023-09-15T04:37:59.713-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": "4x8x2 at $789.80",
"due_at_move_in": 368.57,
"due_monthly": 789.8,
"extra_details": {
"saved_cyo_options_ids": "[]",
"snapshot_reservation_id": "05ea3742-b417-4566-b6eb-d2ef53c85dd0"
},
"facility_id": "1858c9ad-4abc-4e1c-98ad-30ed99fa4586",
"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": "2023-09-15T00:00:00.000-10:00",
"next_lead_action": null,
"next_lead_action_index": null,
"origination": "reservation",
"plant_a_tree": false,
"quoted_rate": 789.8,
"rate_type": "standard_rate",
"reduced_price": 789.8,
"reservation_fee_required": true,
"reservation_window": 0,
"reserved_at": "2023-09-15T04:37:59.706-10:00",
"size": "4x8x2",
"source_id": "828e875d-1858-43d7-9eea-0272c8d7065d",
"source_name": "Test App",
"standard_rate": 789.8,
"started_at": "2023-09-15T04:37:59.713-10:00",
"status": "reserved",
"tenant_id": "f678fa5c-ea8e-4103-b17d-907dbd2944dc",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "f678fa5c-ea8e-4103-b17d-907dbd2944dc",
"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": "2023-09-15T04:37:58.801-10:00",
"gate_24_hour_access": false,
"active": true,
"tenant_account_kind_name": "Standard",
"blocked_payments": false,
"date_of_birth": null,
"phone_numbers": [
{
"id": "75b46d5c-58dd-49ea-b0e1-dbdeb8412b34",
"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": "1858c9ad-4abc-4e1c-98ad-30ed99fa4586",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"6ef5ddcc-e0a5-455b-b518-2a80c204cd66",
"9a4da457-52d3-493b-9cbc-0ab860673ed7"
],
"password_recovery_question_ids": []
},
"unit": {
"id": "c473f996-6caa-4a2e-9337-df4d684f4d19",
"price": 789.8,
"name": "U78",
"description": "",
"width": 4.0,
"length": 8.0,
"height": 2.0,
"door_height": 7.0,
"door_width": 1.0,
"door_type": "roll_up",
"access_type": "indoor",
"floor": null,
"directions": null,
"size": "4x8x2",
"area": 32.0,
"standard_rate": 789.8,
"managed_rate": null,
"tiered_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,
"rank": null,
"custom_fields": [],
"allow_future_move_ins_limit": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "d5a071b9-10df-4e50-b61d-9fa09a92ecdb",
"name": "Unit Type 101",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"tier": null,
"unit_group_id": "84491101-2500-4521-b382-4ef2feb5ee31"
},
"length_of_stay": null,
"successful_payment_events": [
{
"id": "9a4da457-52d3-493b-9cbc-0ab860673ed7",
"amount": 5.99,
"success": true,
"date": "2023-09-15T04:37:59.474-10:00",
"payment_method": {
"id": "eba83538-13a3-4277-924c-78d8d87b8d37",
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"reuseable": false,
"card_number": "****0000",
"card_type": "visa",
"expiration_date": "10/24",
"billing_address": {
"id": "bbcd303f-a053-47d8-910f-7a0e71604b55",
"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": "d5a071b9-10df-4e50-b61d-9fa09a92ecdb",
"name": "Unit Type 101",
"deleted": false,
"internal_account_code": "4000",
"code_and_description": "4000 - Rental Revenue",
"ii_excluded": []
},
"close_reason": null,
"discount_plans": [],
"lead_contents": [],
"unit_group": {
"id": "84491101-2500-4521-b382-4ef2feb5ee31",
"price": 789.8,
"group_key": "4x8x2 - $789.80 - 3188",
"name": "U78 - Group",
"available_units_count": 0,
"total_units_count": 1,
"total_non_excluded_units_count": 1,
"size": "4x8x2",
"standard_rate": 789.8,
"floor": null,
"reduced_price": 789.8,
"cyo_reduced_prices": {},
"occupancy_percent": 0.0,
"area": 32.0,
"length": 8.0,
"width": 4.0,
"height": 2.0,
"due_at_move_in": 789.8,
"due_at_move_in_without_fees": 789.8,
"due_monthly": 789.8,
"attribute_description": null,
"description": "",
"invoiceable_fees": [],
"average_rent": 0.0,
"active_rate_type": "standard_rate",
"scheduled_move_outs": [],
"managed_rate": null,
"reservation_fee": {
"id": "3917a2ec-1557-4bf1-8f85-2239ab699367",
"product_code": "FEE-2",
"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
},
"reference_unit_id": null,
"channel_rate": null,
"unit_amenities": [],
"unit_type": {
"id": "d5a071b9-10df-4e50-b61d-9fa09a92ecdb",
"name": "Unit Type 101",
"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": "828e875d-1858-43d7-9eea-0272c8d7065d",
"confirmation_email": null
},
"meta": {
"status_code": 201,
"status_message": "Created",
"status_cat": "https://http.cat/201",
"request_method": "POST",
"request_id": null,
"parameters": {
"payment_method": {
"kind": "credit_card",
"first_name": "John",
"last_name": "Doe",
"card_type": "visa",
"card_number": "[FILTERED]",
"security_code": "[FILTERED]",
"expiration_date": "10/24",
"billing_address_attributes": {
"address1": "123 Main",
"city": "Somecity",
"state": "AL",
"postal": "12345",
"country": "US"
}
},
"lead": {
"is_reservation": true,
"desired_move_in_date": "2023-09-17",
"unit_id": "c473f996-6caa-4a2e-9337-df4d684f4d19",
"tenant_attributes": {
"first_name": "John",
"phone_numbers_attributes": [
{
"number": "3333333333",
"sms_opt_in": true
}
]
}
},
"facility_id": "1858c9ad-4abc-4e1c-98ad-30ed99fa4586"
}
}
}
PATCH /v1/:facility_id/leads/:id
Update an existing lead
PUT /v1/:facility_id/leads/:id
Update an existing lead
Params
| Param name | Description |
|---|---|
|
lead
required |
Validations:
|
|
lead[tenant_id]
optional |
A tenant record to associate the lead with. Required if Validations:
|
|
lead[tenant_attributes]
optional |
Attributes to create a tenant record. Required if Validations:
|
|
lead[tenant_attributes][title]
optional |
Validations:
|
|
lead[tenant_attributes][first_name]
required |
Validations:
|
|
lead[tenant_attributes][last_name]
optional |
Validations:
|
|
lead[tenant_attributes][middle_initial]
optional |
Validations:
|
|
lead[tenant_attributes][last_name]
optional |
Validations:
|
|
lead[tenant_attributes][email]
optional |
Validations:
|
|
lead[tenant_attributes][is_military]
optional |
True if the tenant record is a in the military. Validations:
|
|
lead[tenant_attributes][is_business]
optional |
True if the tenant record is a commercial entity. Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes]
required |
A collection of phone numbers. At least one is required. Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][number]
required |
Phone number Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][extension]
optional |
Phone number extension Validations:
|
|
lead[tenant_attributes][phone_numbers_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
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. Validations:
|
|
lead[tenant_attributes][mailing_address_attributes]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][address1]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][address2]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][city]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][state]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][postal]
optional |
Validations:
|
|
lead[tenant_attributes][mailing_address_attributes][time_zone]
optional |
Valid IANA timezone identifier of the address (see http://www.iana.org/time-zones) Validations:
|
|
lead[unit_id]
optional |
The ID of the unit to reserve. Required if Validations:
|
|
lead[online_move_in_url]
optional |
The URL the lead can use to complete the move in Validations:
|
|
lead[id]
optional |
The ID of the lead (update only). Validations:
|
|
lead[is_reservation]
required |
Is the lead a reservation? Validations:
|
|
lead[caller_first_name]
optional |
First name of the caller, if different from the tenant Validations:
|
|
lead[caller_last_name]
optional |
Last name of the caller, if different from the tenant Validations:
|
|
lead[urgent]
optional |
Validations:
|
|
lead[quoted_rate]
optional |
Validations:
|
|
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. Validations:
|
|
lead[size]
optional |
Validations:
|
|
lead[floor]
optional |
Validations:
|
|
lead[lead_contents]
optional |
A collection of marketing content. Validations:
|
|
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. Validations:
|
|
lead[desired_move_in_date]
optional |
Format: YYYY-MM-DD Validations:
|
|
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. Validations:
|
|
lead[free_truck]
optional |
Interested in a free truck Validations:
|
|
lead[moving_labor]
optional |
Interested in having help with moving Validations:
|
|
lead[call_source]
optional |
Where the call was initiated from Validations:
|
|
lead[dnis]
optional |
An identifier for the facility the lead was trying to reach - see http://en.wikipedia.org/wiki/Dialed_Number_Identification_Service Validations:
|
|
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. Validations:
|
|
lead[lead_action_performed]
optional |
The kind of action that was performed on the lead Validations:
|
|
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) Validations:
|
|
lead[next_lead_action]
optional |
The kind of follow up action that will be performed Validations:
|
|
lead[notes_attributes]
optional |
A collection of notes. Validations:
|
|
lead[notes_attributes][note]
required |
Note body - freeform text Validations:
|
|
lead[caller_phone_number_attributes]
required |
Phone number of the caller, if different from the tenant Validations:
|
|
lead[caller_phone_number_attributes][number]
required |
Phone number Validations:
|
|
lead[caller_phone_number_attributes][extension]
optional |
Phone number extension Validations:
|
|
lead[caller_phone_number_attributes][label]
optional |
A label for what the phone number is, such as Home, Work, Mobile, etc. Validations:
|
|
lead[rate_type]
optional |
The type of rate for the unit (ie. Validations:
|
|
lead[discount_plans]
optional |
Must be an array of nested discount plan ids Validations:
|
|
lead[discount_plans][id]
optional |
The ID of the discount plan to apply. Validations:
|
|
lead[payment_method]
required |
Can accept a paymentmethodid, or fields for CC or ACH payments Validations:
|
|
lead[payment_method][payment_method_id]
optional |
If you want to use an existing payment method, pass in the id Validations:
|
|
lead[payment_method][first_name]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][last_name]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][kind]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][reuseable]
optional |
Validations:
|
|
lead[payment_method][magnetic_track]
optional |
Required if using a card swipe Validations:
|
|
lead[payment_method][card_number]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][card_type]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][security_code]
optional |
Required if using a credit card Validations:
|
|
lead[payment_method][expiration_date]
optional |
Required if using a credit card. Format: MM/YY Validations:
|
|
lead[payment_method][account_number]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][account_number_confirmation]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][account_type]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][bank_name]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][routing_number]
optional |
Required if using ACH Validations:
|
|
lead[payment_method][billing_address_attributes]
optional |
Required if not using an existing payment method Validations:
|
|
lead[payment_method][billing_address_attributes][company]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][address1]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][address2]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][city]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][postal]
optional |
Validations:
|
|
lead[payment_method][billing_address_attributes][state]
optional |
Validations:
|
|
lead[payment_method][check_number]
optional |
Required if using Check Validations:
|
|
lead[payment_method][name_on_check]
optional |
Required if using Check Validations:
|
|
lead[payment_method][check_amount]
optional |
Required if using Check Validations:
|
|
lead[payment_method][reference_number]
optional |
Required if using Money Order Validations:
|
|
lead[payment_method][money_order_amount]
optional |
Required if using Money Order Validations:
|
|
lead[payment_method][amount_tendered]
optional |
Required if using Cash Validations:
|
Examples
PUT /v1/fca9ad5e-5c7e-4066-8553-506712883179/leads/ecc1435e-baad-4a38-b908-cedc00b5262e
{
"lead": {
"desired_move_in_date": "2023-09-17",
"notes_attributes": [
{
"note": "A shorter note"
}
],
"tenant_attributes": {
"first_name": "Joseph"
}
}
}
200
{
"lead": {
"id": "ecc1435e-baad-4a38-b908-cedc00b5262e",
"bilingual_agent": false,
"caller_first_name": null,
"caller_last_name": null,
"cancelled_at": null,
"closed": false,
"confirmation_number": null,
"created_at": "2023-09-15T04:38:00.387-10:00",
"desired_move_in_date": "2023-09-17",
"desired_unit_size_and_price": null,
"due_at_move_in": null,
"due_monthly": null,
"extra_details": {},
"facility_id": "fca9ad5e-5c7e-4066-8553-506712883179",
"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": "2023-09-15T00: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": "8c4dc31b-cd53-4b66-a84f-d80a1870d625",
"source_name": "Test App",
"standard_rate": null,
"started_at": "2023-09-15T04:38:00.387-10:00",
"status": "created",
"tenant_id": "4ae2f47a-281b-4b50-9015-5d8b91302d46",
"urgent": false,
"wait_list": false,
"wait_list_available": false,
"within_reservation_window": true,
"is_upgrade": null,
"desired_unit_size_and_amenities": null,
"tenant": {
"id": "4ae2f47a-281b-4b50-9015-5d8b91302d46",
"account_number": 1000000,
"first_name": "Joseph",
"last_name": "Quigley",
"middle_initial": null,
"email": "[email protected]",
"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_109",
"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": "2023-09-15T04:38:00.368-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": "66c9e7d2-79cc-47f3-91c2-e10ed5546eae",
"address1": "716993 Gerlach Parks",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "716993 Gerlach Parks, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
},
"addresses": [
{
"id": "66c9e7d2-79cc-47f3-91c2-e10ed5546eae",
"address1": "716993 Gerlach Parks",
"address2": null,
"city": "North Cruzfurt",
"state": "DE",
"postal": "89980",
"country": "US",
"full_address": "716993 Gerlach Parks, North Cruzfurt, DE 89980",
"latitude": 39.114844,
"longitude": -94.630169,
"time_zone_id": "America/New_York",
"time_zone_offset": "-04:00",
"invalid_data": false,
"label": "Home"
}
],
"facility_id": "fca9ad5e-5c7e-4066-8553-506712883179",
"previous_ledger_ids": [],
"closed_lead_ids": [],
"contact_ids": [],
"support_case_ids": [],
"event_ids": [
"b265e8fe-2852-46a5-941b-ddb38b12f723",
"16fbc79f-b6c2-46bc-b76f-1b994d7cb11c"
],
"password_recovery_question_ids": [
"97052f56-60b0-4c50-bc3b-fa18388cafc7",
"b4aa4b71-6454-4abd-8502-a44d60128f4a"
]
},
"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": "8c4dc31b-cd53-4b66-a84f-d80a1870d625",
"name": "Test App",
"type": "Source"
},
"channel_id": "8c4dc31b-cd53-4b66-a84f-d80a1870d625",
"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": "2023-09-17",
"notes_attributes": [
{
"note": "A shorter note"
}
],
"tenant_attributes": {
"first_name": "Joseph"
}
},
"facility_id": "fca9ad5e-5c7e-4066-8553-506712883179",
"id": "ecc1435e-baad-4a38-b908-cedc00b5262e"
}
}
}
DELETE /v1/:facility_id/leads/:id
Destroy a lead
Params
| Param name | Description |
|---|---|
|
id
required |
Validations:
|
Examples
DELETE /v1/81d1ce69-8dcc-4fb4-a768-25228cbe8ea5/leads/d2e4d72b-fb5d-43b0-a243-9d3be85665ea
{
"lead": {
"close_reason_id": "1265fc15-5d9f-42d4-9952-425c473ad4c6",
"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": "1265fc15-5d9f-42d4-9952-425c473ad4c6",
"notes_attributes": [
{
"note": "A++ would rent again!"
}
]
},
"facility_id": "81d1ce69-8dcc-4fb4-a768-25228cbe8ea5",
"id": "d2e4d72b-fb5d-43b0-a243-9d3be85665ea"
}
}
}