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:

  • Must be a Hash
lead[tenant_id]
optional

A tenant record to associate the lead with. Required if tenant_attributes are not given.

Validations:

  • Must be a String
lead[tenant_attributes]
optional

Attributes to create a tenant record. Required if tenant_id is not given.

Validations:

  • Must be a Hash
lead[tenant_attributes][title]
optional

Validations:

  • Must be a String
lead[tenant_attributes][first_name]
required

Validations:

  • Must be a String
lead[tenant_attributes][last_name]
optional

Validations:

  • Must be a String
lead[tenant_attributes][middle_initial]
optional

Validations:

  • Must be a String
lead[tenant_attributes][last_name]
optional

Validations:

  • Must be a String
lead[tenant_attributes][email]
optional

Validations:

  • Must be a String
lead[tenant_attributes][is_military]
optional

True if the tenant record is a in the military.

Validations:

  • Must be one of: true, false, 1, 0.
lead[tenant_attributes][is_business]
optional

True if the tenant record is a commercial entity.

Validations:

  • Must be one of: true, false, 1, 0.
lead[tenant_attributes][phone_numbers_attributes]
required

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

Validations:

  • Must be an Array of nested elements
lead[tenant_attributes][phone_numbers_attributes][number]
required

Phone number

Validations:

  • Must be a String
lead[tenant_attributes][phone_numbers_attributes][extension]
optional

Phone number extension

Validations:

  • Must be a String
lead[tenant_attributes][phone_numbers_attributes][label]
optional

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

Validations:

  • Must be a String
lead[tenant_attributes][phone_numbers_attributes][sms_opt_in]
optional

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

Validations:

  • Must be one of: true, false, 1, 0.
lead[tenant_attributes][mailing_address_attributes]
optional

Validations:

  • Must be a Hash
lead[tenant_attributes][mailing_address_attributes][address1]
optional

Validations:

  • Must be a String
lead[tenant_attributes][mailing_address_attributes][address2]
optional

Validations:

  • Must be a String
lead[tenant_attributes][mailing_address_attributes][city]
optional

Validations:

  • Must be a String
lead[tenant_attributes][mailing_address_attributes][state]
optional

Validations:

  • Must be a String
lead[tenant_attributes][mailing_address_attributes][postal]
optional

Validations:

  • Must be a String
lead[tenant_attributes][mailing_address_attributes][time_zone]
optional

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

Validations:

  • Must be a String
lead[unit_id]
optional

The ID of the unit to reserve. Required if is_reservation is true.

Validations:

  • Must be a String
lead[online_move_in_url]
optional

The URL the lead can use to complete the move in

Validations:

  • Must be a String
lead[id]
optional

The ID of the lead (update only).

Validations:

  • Must be a String
lead[is_reservation]
required

Is the lead a reservation?

Validations:

  • Must be one of: true, false, 1, 0.
lead[caller_first_name]
optional

First name of the caller, if different from the tenant

Validations:

  • Must be a String
lead[caller_last_name]
optional

Last name of the caller, if different from the tenant

Validations:

  • Must be a String
lead[urgent]
optional

Validations:

  • Must be one of: true, false, 1, 0.
lead[quoted_rate]
optional

Validations:

  • Must be a String
lead[length_of_stay_id]
optional

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

Validations:

  • Must be a String
lead[size]
optional

Validations:

  • Must be a String
lead[floor]
optional

Validations:

  • Must be a String
lead[lead_contents]
optional

A collection of marketing content.

Validations:

  • Must be an Array of nested elements
lead[lead_contents][id]
optional

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

Validations:

  • Must be a String
lead[desired_move_in_date]
optional

Format: YYYY-MM-DD

Validations:

  • Must be a Date
lead[desired_unit_size_and_price]
optional

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

Validations:

  • Must be a String
lead[free_truck]
optional

Interested in a free truck

Validations:

  • Must be one of: true, false, 1, 0.
lead[moving_labor]
optional

Interested in having help with moving

Validations:

  • Must be one of: true, false, 1, 0.
lead[call_source]
optional

Where the call was initiated from

Validations:

  • Must be a String
lead[dnis]
optional

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

Validations:

  • Must be a String
lead[close_reason_id]
optional

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

Validations:

  • Must be a String
lead[lead_action_performed]
optional

The kind of action that was performed on the lead

Validations:

  • Must be one of: call, email, text.
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:

  • Must be a Integer
lead[next_lead_action]
optional

The kind of follow up action that will be performed

Validations:

  • Must be one of: call, email, text.
lead[notes_attributes]
optional

A collection of notes.

Validations:

  • Must be an Array of nested elements
lead[notes_attributes][note]
required

Note body - freeform text

Validations:

  • Must be a String
lead[caller_phone_number_attributes]
required

Phone number of the caller, if different from the tenant

Validations:

  • Must be a Hash
lead[caller_phone_number_attributes][number]
required

Phone number

Validations:

  • Must be a String
lead[caller_phone_number_attributes][extension]
optional

Phone number extension

Validations:

  • Must be a String
lead[caller_phone_number_attributes][label]
optional

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

Validations:

  • Must be a String
lead[rate_type]
optional

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

Validations:

  • Must be a String
lead[discount_plans]
optional

Must be an array of nested discount plan ids

Validations:

  • Must be an Array of nested elements
lead[discount_plans][id]
optional

The ID of the discount plan to apply.

Validations:

  • Must be a String
lead[payment_method]
required

Can accept a paymentmethodid, or fields for CC or ACH payments

Validations:

  • Must be a Hash
lead[payment_method][payment_method_id]
optional

If you want to use an existing payment method, pass in the id

Validations:

  • Must be a String
lead[payment_method][first_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String
lead[payment_method][last_name]
optional

Required if not using an existing payment method

Validations:

  • Must be a String
lead[payment_method][kind]
optional

Required if not using an existing payment method

Validations:

  • Must be one of: ach, creditcard, check, cash, cardswipe.
lead[payment_method][reuseable]
optional

Validations:

  • Must be one of: true, false, 1, 0.
lead[payment_method][magnetic_track]
optional

Required if using a card swipe

Validations:

  • Must be a String
lead[payment_method][card_number]
optional

Required if using a credit card

Validations:

  • Must be a String
lead[payment_method][card_type]
optional

Required if using a credit card

Validations:

  • Must be one of: visa, mastercard, american_express, diners, discover, jcb.
lead[payment_method][security_code]
optional

Required if using a credit card

Validations:

  • Must be a String
lead[payment_method][expiration_date]
optional

Required if using a credit card. Format: MM/YY

Validations:

  • Must be a String
lead[payment_method][account_number]
optional

Required if using ACH

Validations:

  • Must be a String
lead[payment_method][account_number_confirmation]
optional

Required if using ACH

Validations:

  • Must be a String
lead[payment_method][account_type]
optional

Required if using ACH

Validations:

  • Must be a String
lead[payment_method][bank_name]
optional

Required if using ACH

Validations:

  • Must be a String
lead[payment_method][routing_number]
optional

Required if using ACH

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes]
optional

Required if not using an existing payment method

Validations:

  • Must be a Hash
lead[payment_method][billing_address_attributes][company]
optional

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes][address1]
optional

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes][address2]
optional

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes][city]
optional

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes][postal]
optional

Validations:

  • Must be a String
lead[payment_method][billing_address_attributes][state]
optional

Validations:

  • Must be a String
lead[payment_method][check_number]
optional

Required if using Check

Validations:

  • Must be a String
lead[payment_method][name_on_check]
optional

Required if using Check

Validations:

  • Must be a String
lead[payment_method][check_amount]
optional

Required if using Check

Validations:

  • Must be a String
lead[payment_method][reference_number]
optional

Required if using Money Order

Validations:

  • Must be a String
lead[payment_method][money_order_amount]
optional

Required if using Money Order

Validations:

  • Must be a String
lead[payment_method][amount_tendered]
optional

Required if using Cash

Validations:

  • Must be a String

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