update`

This action updates the information associated with the property.

Request

Field	Description	Required
`org_property_id`	Property’s unique identifier	Yes
`values`	Property information that needs to be updated	Yes

The values must be a JSON object. The keys in this object must be a valid canonical property field name. The values in this object depends on the type of the property field and should be set as follows:

Property Field Type	Valid value(s)
`text`	Text value
`date`	Date value. Accepted formats: `MM/DD/YYYY`, `YYYY-MM-DD`, `YYYYMMDD`
`dropdown`	Canonical value from the `options` object in the `fields.PROP_FIELD` object returned by `/property/get`
`multiselect`	JSON array. Each item in the array must a canonical value from the `options` object in the `fields.PROP_FIELD` object returned by `/property/get`
`bool/yn`	`1` (Yes) or `0` (No)
`bool/oo`	`1` (On) or `0` (Off)

Example:

{
  "org_property_id": 5666,
  "values": {
    "property_investor_id": "4",
    "property_gas_status": "0",
    "property_gas_last_reading": "8394",
    "property_vpr_filed": "0",
    "property_published_occupancy_date": "20201202",
    "property_flag": [34,35]
  }
}

    curl -v \
         -H 'Content-Type: application/json' \
         -H 'Authorization: Bearer ACCESS_TOKEN' \
         -d '{"org_property_id":5666,"values":{"property_investor_id":"4","property_gas_status":"0","property_gas_last_reading":"8394","property_vpr_filed":"0","property_published_occupancy_date":"20201202", "property_flag": [34,35]}}' \
        https://ppw.web/svc/property/update

Response

Example successful response:

{
  "result": "Property updated"
}

Updatable Property Fields

The following table contains the property fields that can be updated through this action:

Property Field Name	Canonical Property Field Name	Type
Date ICC	`conveyance_date`	`date`
Conveyance Date	`property_conveyance_date`	`date`
Conveyance Due Date	`property_original_conveyance_date`	`date`
New Conveyance Due Date	`property_new_conveyance_date`	`date`
FTV	`first_time_vacant`	`date`
Routing Date	`routing_date`	`date`
Deed Recorded Date	`deed_recorded_date`	`date`
Lock Code	`property_lock_code`	`text`
ICC (Yes/No)	`property_in_conveyance_condition`	`bool/yn`
Initial Default Date	`property_initial_default_date`	`date`
Lot Size	`property_lot_size`	`text`
Loan Number	`property_loan_number`	`text`
Loan Type	`property_loan_type`	`dropdown`
Mortgagee	`property_mortgagee`	`text`
Investor	`property_investor_id`	`dropdown`
Initial Secure Date	`property_initial_secure_date`	`date`
Gas Status	`property_gas_status`	`bool/oo`
Gas Last Reading	`property_gas_last_reading`	`text`
Gas Total Spent	`property_gas_total_spent`	`text`
Electric Status	`property_electric_status`	`bool/oo`
Electric Last Reading	`property_electric_last_reading`	`text`
Electric Total Spent	`property_electric_total_spent`	`text`
Water Status	`property_water_status`	`bool/oo`
Water Last Reading	`property_water_last_reading`	`text`
Water Total Spent	`property_water_total_spent`	`text`
Property Key Code	`property_key_code`	`text`
Lockbox Code	`property_lock_box_code`	`text`
VPR Required	`property_vpr_required`	`bool/yn`
VPR Filed	`property_vpr_filed`	`bool/yn`
VPR Expiration Date	`property_vpr_expiration_date`	`date`
Extension Request (Yes/No)	`property_extension_request`	`bool/yn`
Extension Request Date	`property_extension_request_date`	`date`
Property Status	`property_status`	`dropdown`
Is the mortgage holder a soldier or sailer?	`property_mh_ss`	`bool/yn`
First Inspection Date	`property_first_inspection_date`	`date`
VPS Securing Code	`property_vps_securing_code`	`text`
Vacant Land Identifier	`property_vacant_land_ident`	`text`
Investor Case Number	`property_investor_case_number`	`text`
Investor Code	`property_investor_code`	`text`
Recurring Grass Cut Active (Yes/No)	`property_recurring_grass_cuts_active`	`bool/yn`
Inspection Cycle	`property_inspection_cycle`	`text`
Current Occupancy Status	`property_current_occupancy_status`	`text`
Published Occupancy Date	`property_published_occupancy_date`	`date`
Winterized	`property_winterized`	`date`
Foreclosure Sale Date	`property_foreclosure_sale_date`	`date`
Date Loan Fell out of ICC	`property_date_loan_foo_icc`	`date`
Stop Work Date	`property_stop_work_date`	`date`
Stop Work Reason	`property_stop_work_reason`	`text`
Stop Work Info	`property_stop_work_info`	`text`
Geocode Info	`property_geocode_info`	`text`
Pool On Site? (Yes/No)	`property_pool_onsite`	`bool/yn`
Sump Pump On Site? (Yes/No)	`property_sump_pump_onsite`	`bool/yn`
Sump Pump Operational? (Yes/No)	`property_sump_pump_operational`	`bool/yn`
HOA Identifier	`property_hoa_ident`	`text`
HOA Name	`property_hoa_name`	`text`
HOA Phone No	`property_hoa_phone`	`text`
Last Grasscut Date	`property_last_grasscut_date`	`date`
Lock Change Date	`property_lock_change_date`	`date`
Last Inspected Date	`property_last_inspected_date`	`date`
Latest ICC Date	`property_latest_icc_date`	`date`
Extension Approval Date	`property_extension_approval_date`	`date`
Environmental Flag? (Yes/No)	`property_environmental_flag`	`bool/yn`
Asset ID	`property_asset_id`	`text`
Servicer Family #	`property_servicer_family_num`	`text`
Servicer Loan #	`property_servicer_loan_num`	`text`
Property Type	`property_type`	`text`
P&M Vendor	`property_p_and_m_vendor`	`text`
General Contractor	`property_general_contractor`	`text`
Sales Specialist	`property_sales_specialist`	`text`
Strategy	`property_strategy`	`text`
Repair Spend Range	`property_repair_spend_range`	`text`
Final Approved Bid	`property_approved_repair_bid`	`text`
Final EMV	`property_final_emv`	`text`
Original List	`property_original_list`	`text`
Current List	`property_current_list`	`text`
# of Reductions	`property_num_of_reductions`	`text`
Last Interior Clean Date	`property_last_interior_clean_date`	`date`
Status	`property_freddie_mac_status`	`text`
Sub-Status	`property_freddie_mac_sub_status`	`text`
DOM	`property_dom`	`text`
DII	`property_dii`	`text`
BPO as-is	`property_bpo_as_is`	`text`
BPO w/ Repairs	`property_bpo_with_repairs`	`text`
2nd BPO as-is	`property_second_bpo_as_is`	`text`
2nd BPO w/ Repairs	`property_second_bpo_with_repairs`	`text`
Primary Vendor	`property_primary_vendor`	`dropdown`
Inspection Vendor	`property_inspection_vendor`	`dropdown`
Property Id	`property_property_id`	`text`
Pre FC Values	`property_pre_fc_values`	`text`
Lien Position	`property_lien_position`	`text`
Client Deal Name	`property_client_deal_name`	`text`
Borrower Name	`property_borrower_name`	`text`
Borrower Email	`property_borrower_email`	`text`
Borrower Phone	`property_borrower_phone`	`text`
Tax Parcel Number	`property_tax_parcel_number`	`text`
Product Type	`property_product_type`	`text`
Unpaid Principal Balance	`property_unpaid_principal_balance`	`number`
Cancellation FLAGS 1-STCONDCDELIST	`property_cancellation_f1_stcondcdelist`	`text`
Cancellation FLAGS 2-RPTSTCDELIST	`property_cancellation_f2_rptstcdelist`	`text`
Cancellation FLAGS 3-USERCDELIST	`property_cancellation_f3_usercdelist`	`text`
Cancellation FLAGS 4-TKLR2CDELIST	`property_cancellation_f4_tklr2cdelist`	`text`
Request Code	`property_request_code`	`text`
REO Date	`property_reo_date`	`date`
Confirmed Sale Date	`property_confirmed_sale_date`	`date`
Inspection Required	`property_inspection_required`	`bool/yn`
Boarding Date	`property_boarding_date`	`date`
Org. Estimate Closing Date	`property_est_closing_date`	`date`
Client Status	`property_client_status`	`dropdown`
WIFCD	`property_wifcd`	`date`
Property Flag	`property_flag`	`multiselect`
Customer	`property_customer`	`dropdown`
Property - Total Invoiced Client	`property_total_invoiced_client`	`number`
Property - Total Invoiced Contractor	`property_total_invoiced_contractor`	`number`
Client Company	`property_client_company`	`dropdown`
Front of House Photo	`foh_file_id`	`text`
Acquisition Date	`property_acquisition_date`	`date`
Acquisition Type	`property_acquisition_type`	`text`
Fee Status Code	`property_fee_status_code`	`text`
Contract Area	`property_contract_area`	`text`
Date FSM Assigned	`property_date_fsm_assigned`	`date`
AM Name	`property_am_name`	`text`
11 - Preconveyance	`property_preconveyance`	`date`
0 - Conveyance	`property_conveyance`	`date`
1 - Acquisition	`property_acquisition`	`date`
1a - Initial Inspection Complete	`property_initial_inspection_complete`	`date`
1b - Clean-out Complete	`property_cleanout_complete`	`date`
1c - Ready to Show Condition	`property_ready_to_show_condition`	`date`
2 - Appraisal Complete	`property_appraisal_complete`	`date`
3a - Disposition Pending	`property_disposition_pending`	`date`
3 - Held Off Market	`property_heldoff_market`	`date`
4 - Direct Sale	`property_direct_sale`	`date`
5 - Ready to List	`property_ready_to_list`	`date`
6 - Listed for Sale	`property_listed_for_sale`	`date`
7 - Preliminary Offer	`property_preliminary_offer`	`date`
8 - Sales Offer	`property_sales_offer`	`date`
9 - Sale Closed	`property_sale_closed`	`date`
10 - Reconciled	`property_reconciled`	`date`
Total Paid to Client	`property_total_paid_client`	`number`
Total Paid to Contractor	`property_total_paid_contractor`	`number`

Errors

Error Type	Description	Status Code
`invalid_request`	`org_property_id` not set in request or is invalid	`400`
`values_required`	`values` not set or is invalid`	`400`
`invalid_field`	A property field in `values` is invalid	`400`
`invalid_date`	A property field of type `date` has an invalid value	`400`
`invalid_option`	A property field of type `dropdown` has an invalid value	`400`
`invalid_yes_no`	A property field of type `bool/yn` has an invalid value	`400`
`invalid_on_off`	A property field of type `bool/oo` has an invalid value	`400`
`access_denied`	Access token is invalid or expired	`401`
`scope_invalid`	Client app does not have the required OAuth scope	`403`

Keyboard shortcuts

PPW API Services

/property/update

Request

Response

Updatable Property Fields

Errors

`/property/update`