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"
}
}
}