Edit Prospect

Edit a limited number of fields on a specified company prospect. This endpoint allows you to update the prospect's status and optionally provide application details when setting status to 'applicant' or 'resident'. The application object is only required when setting status to 'applicant' or 'resident'. Prospect data must be nested under the 'client' key in the JSON body.

PUT

/api/v2/clients/:client_id

Request

Example request (with application)PUTapplication/json

$ curl -X PUT \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer YOUR_API_KEY" \
    -d '{ "status": "applicant", "application": { "unit_id": 123, "lease_start_date": "2020-06-01", "lease_expiration_date": "2020-05-31", "application_submitted_date": "2020-05-20", "application_price": "1200.00" } }' \
    "https://api.funnelleasing.com/api/v2/clients/890"

Response

Example responseJSON200 · application/json

{
"data": {
  "client": {
    "id": 111,
    "group": 20,
    "broker_email": "",
    "broker_phone": "",
    "broker_name": " ",
    "people": [
      {
        "first_name": "Lara",
        "last_name": "Smith",
        "preferred_name": "",
        "email": "lara.smith@outlook.com",
        "phone_1": "555-777-5555",
        "phone_2": "",
        "id": 27,
        "is_primary": true,
        "email_updates_opt_in": 10,
        "sms_opted_in": 10,
        "move_out_date": null
      }
    ],
    "move_in_date": null,
    "client_referral": "None",
    "campaign_info": "None",
    "layout": "",
    "price_floor": null,
    "price_ceiling": null,
    "discovery_source": null,
    "status": "Applicant",
    "active_live_chat_id": null,
    "sms_opted_in": 10
  }
}
}

Simple Status Change Example

For a simple status change without application details:

Example request (status change only)JSON200 · application/json

{
  "status": "toured"
}

Invalid Application Data (400)

If the provided data in the application fields is not valid, a 400 error response will be returned.

Error responseJSON400 · application/json

{
"errors": {
  "application": {
    "unit_id": "missing or invalid data",
    "lease_start_date": "missing or invalid data",
    "application_submitted_date": "missing or invalid data"
  }
}
}

Invalid Status (400)

If the provided status choice is not valid, a 400 error response will be returned.

Error responseJSON400 · application/json

{
"errors": {
  "status": ["missing or invalid data"]
}
}