If a field is omitted from the request body, then the existing value for that field will not change.
unit_group_id
:unit_amenities
, tax_rates
, or custom_field_values_attributes
):door_type
none
roll_up
swing
access_type
indoor
outdoor
Param name | Description |
---|---|
unit
required |
Validations:
|
unit[allow_future_move_ins_limit]
optional , nil allowed |
Validations:
|
unit[floor]
optional , nil allowed |
Floor number Validations:
|
unit[rentable]
optional , nil allowed |
Is the unit rentable Validations:
|
unit[combination_lock_number]
optional , nil allowed |
Validations:
|
unit[overlock_lock_number]
optional , nil allowed |
Validations:
|
unit[attribute_description]
optional , nil allowed |
Validations:
|
unit[tax_rates]
optional , nil allowed |
Array of tax rate ids Validations:
|
unit[unit_amenities]
optional , nil allowed |
Array of unit amenity ids Validations:
|
unit[unit_group_id]
optional , nil allowed |
Unit group id; only available when Custom Unit Groups are enabled Validations:
|
unit[tier]
optional , nil allowed |
Tier id. Required if tiering is enabled Validations:
|
unit[rank]
optional , nil allowed |
Rank of the desirability of the unit across all units at the facility Validations:
|
unit[exclude_from_api]
optional , nil allowed |
True if the unit is excluded from relevant API responses; only available if the client application has the "read_excluded" permission. Validations:
|
unit[fully_enclosed]
optional , nil allowed |
True if unit is fully enclosed. If new units belong to an existing unit group, the existing group's value will take precedence. Validations:
|
unit[name]
optional , nil allowed |
Validations:
|
unit[width]
optional , nil allowed |
Validations:
|
unit[length]
optional , nil allowed |
Validations:
|
unit[height]
optional , nil allowed |
Validations:
|
unit[door_height]
optional , nil allowed |
Validations:
|
unit[door_width]
optional , nil allowed |
Validations:
|
unit[door_type]
optional , nil allowed |
Validations:
|
unit[access_type]
optional , nil allowed |
Validations:
|
unit[standard_rate]
optional , nil allowed |
Ignored if facility uses tiered pricing Validations:
|
unit[walk_thru_order]
optional , nil allowed |
Number of unit in walk through order Validations:
|
unit[unit_type]
optional , nil allowed |
Unit type id Validations:
|
unit[custom_field_values_attributes]
optional , nil allowed |
Array of custom field id and value pairs Validations:
|
unit[custom_field_values_attributes][custom_field_id]
optional , nil allowed |
Custom field's ID Validations:
|
unit[custom_field_values_attributes][value]
optional , nil allowed |
Value of the custom field for this unit Validations:
|
PUT /v1/434b7383-5576-48ee-bf86-a65cf3fdea3f/units/cbfed6ba-2742-4f68-a778-4436cdfd29f2 { "unit": { "name": "new unit name", "width": 8, "length": 9, "height": 10, "door_height": 8, "door_width": 9, "door_type": "swing", "access_type": "outdoor", "floor": 0, "walk_thru_order": 5, "standard_rate": 764.95, "rentable": false, "combination_lock_number": "12321", "overlock_lock_number": "54321", "attribute_description": "", "tax_rates": [ "2bf62d80-fd2a-4646-950c-3022772c061a" ], "unit_amenities": [ "edecec5c-7a96-425b-a8a5-286c893356e0" ], "unit_type": "49239ed3-63d2-4aa3-a225-3e4571ad27f7", "tier": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b" } } 200 { "unit": { "id": "cbfed6ba-2742-4f68-a778-4436cdfd29f2", "price": 764.95, "name": "new unit name", "description": "Amenity 3, 0th floor", "width": 8.0, "length": 9.0, "height": 10.0, "door_height": 8.0, "door_width": 9.0, "door_type": "swing", "access_type": "outdoor", "floor": 0, "directions": null, "size": "8x9x10", "area": 60.0, "standard_rate": 764.95, "managed_rate": null, "tiered_rate": null, "available_for_move_in": false, "rentable": false, "status": "vacant", "payment_status": null, "current_ledger_id": null, "current_tenant_id": null, "combo_lock_group": null, "combination_lock_number": "12321", "overlock_lock_number": null, "attribute_description": "", "deleted": false, "damaged": false, "complimentary": null, "unrentable": true, "company_owned": false, "is_prepped": null, "rank": null, "custom_fields": [], "allow_future_move_ins_limit": null, "channel_rate": null, "unit_amenities": [ { "id": "edecec5c-7a96-425b-a8a5-286c893356e0", "name": "Amenity 3", "short_code": "A39", "show_in_sales_center_filter_dropdown": false, "deleted": false, "primary_key_id": 528 } ], "unit_type": { "id": "49239ed3-63d2-4aa3-a225-3e4571ad27f7", "name": "Unit Type 194", "deleted": false, "internal_account_code": "4000", "code_and_description": "4000 - Rental Revenue", "ii_excluded": [] }, "tier": { "id": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b", "description": "Some description 1", "rank": 1, "deleted": false }, "unit_group_id": "c9b5db0f-1f4e-4e85-8b1c-b3301c5709d3" }, "meta": { "status_code": 200, "status_message": "OK", "status_cat": "https://http.cat/200", "request_method": "PUT", "request_id": null, "parameters": { "unit": { "name": "new unit name", "width": 8, "length": 9, "height": 10, "door_height": 8, "door_width": 9, "door_type": "swing", "access_type": "outdoor", "floor": 0, "walk_thru_order": 5, "standard_rate": 764.95, "rentable": false, "combination_lock_number": "12321", "overlock_lock_number": "54321", "attribute_description": "", "tax_rates": [ "2bf62d80-fd2a-4646-950c-3022772c061a" ], "unit_amenities": [ "edecec5c-7a96-425b-a8a5-286c893356e0" ], "unit_type": "49239ed3-63d2-4aa3-a225-3e4571ad27f7", "tier": "87bfa62a-b68c-4dd3-9b28-3bf4a435fc1b" }, "facility_id": "434b7383-5576-48ee-bf86-a65cf3fdea3f", "id": "cbfed6ba-2742-4f68-a778-4436cdfd29f2" } } }