POST /v1/:facility_id/units
Create one or more new units within the same group.

Discussion

This endpoint can create multiple identical units at once by providing a comma-separated list of names for the name parameter.
The unit_group_id field is only available when Custom Unit Groups are enabled. It will assign the unit to the given unit group. Not providing a value or providing a value of null for unit_group_id means the unit will not be assigned to a group.

Params

Param name Description
unit
required

Validations:

  • Must be a Hash
unit[name]
required

Validations:

  • Must be a String
unit[width]
required

Validations:

  • Must be a Integer
unit[length]
required

Validations:

  • Must be a Integer
unit[height]
required

Validations:

  • Must be a Integer
unit[door_height]
required

Validations:

  • Must be a Integer
unit[door_width]
required

Validations:

  • Must be a Integer
unit[door_type]
required

Validations:

  • Must be a String
unit[access_type]
required

Validations:

  • Must be a String
unit[standard_rate]
required

Ignored if facility uses tiered pricing

Validations:

  • Must be a Integer
unit[walk_thru_order]
required

Number of unit in walk through order

Validations:

  • Must be a Integer
unit[unit_type]
required

Unit type id

Validations:

  • Must be a String
unit[floor]
optional , nil allowed

Floor number

Validations:

  • Must be a Integer
unit[rentable]
optional , nil allowed

Is the unit rentable

Validations:

  • Must be one of: true, false, 1, 0.
unit[combination_lock_number]
optional , nil allowed

Validations:

  • Must be a String
unit[overlock_lock_number]
optional , nil allowed

Validations:

  • Must be a String
unit[attribute_description]
optional , nil allowed

Validations:

  • Must be a String
unit[tax_rates]
optional , nil allowed

Array of tax rate ids

Validations:

  • Must be an array of String
unit[unit_amenities]
optional , nil allowed

Array of unit amenity ids

Validations:

  • Must be an array of String
unit[unit_group_id]
optional , nil allowed

Unit group id; only available when Custom Unit Groups are enabled

Validations:

  • Must be a String
unit[tier]
optional , nil allowed

Tier id. Required if tiering is enabled

Validations:

  • Must be a String
unit[rank]
optional , nil allowed

Rank of the desirability of the unit across all units at the facility

Validations:

  • Must be a Integer
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:

  • Must be one of: true, false, 1, 0.
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:

  • Must be one of: true, false, 1, 0.