The id of the group you want to create or update the units for.
group_external_ref
string
group_external_ref
string
The external reference of the group you want to create or update the units for.
units
object
*
units
Required
object
A list of units to be updated or created
identifier
string
identifier
string
A unique identifier for the unit.
This will be used when determining whether a unit needs to be updated or created.
If this matches a unit in the groups you have specified that unit will be updated, otherwise a new one will be created.
The identifier for a unit can not be updated once it has been set.
When creating a new unit, a random, unique identifier will be set.
Any value passed in this request will only be used for finding an existing unit.
external_ref
string
external_ref
string
An external reference for the unit you want to create or update.
This is typically an identifier you may use for unit records in your own system.
has_flex_wall
boolean
has_flex_wall
boolean
True if the unit is a flex apartment, false if it is not.
number_of_bathrooms
integer
number_of_bathrooms
integer
The unit’s number of bathrooms.
number_of_bedrooms
integer
number_of_bedrooms
integer
The unit’s number of bedrooms.
sqft
integer
sqft
integer
The square feet surface for the unit.
unit_number
string
unit_number
string
The unit’s number.
bathrooms
object
bathrooms
object
A list of bathroom characteristics for each bathroom in the unit.
has_shower_or_bath
boolean
has_shower_or_bath
boolean
Does the bathroom have either a shower or a bath?
has_sink
boolean
has_sink
boolean
Does the bathroom have a sink?
has_toilet
boolean
has_toilet
boolean
Does the bathroom have a toilet?
address
object
address
object
Address information for the unit to be created or updated.
building_name
string
building_name
string
The name of the building.
address_line_1
string
*
address_line_1
Required
string
The first line of the unit’s address.
address_line_2
string
address_line_2
string
The second line of the unit’s address.
city
string
city
string
The city of the unit’s address.
country
string
country
string
The country of the unit’s address.
state
string
*
state
Required
string
The state in which the unit’s address is located.
postal_code
string
*
postal_code
Required
string
The postal code of the unit’s address.
latitude
number
latitude
number
The latitude of the unit’s address.
longitude
number
longitude
number
The longitude of the unit’s address.
A group must be provided for updating or creating the units.
You can provide either a group id through the group_id parameter or a group external reference through the group_external_ref attribute.
Do not provide both, as this will result in the request failing.
If no group id or group external reference is provided, the operation will fail.
This endpoint firstly attempts to match the provided units data with existing units via the unit’s identifier body parameter, in order to update an existing entry.
If a unit is not found via the identifier or the identifier parameter is not set, the endpoint attempts to match an existing unit via the address.
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code.
Status Code - 400
Missing Authorization header
{"error":{"type":"missing_authorization","message":"Your request does not include an 'Authorization' header with a bearer token for your account."}}
Status Code - 401
Expired Authorization header bearer token value
{"error":{"type":"expired_token","message":"The bearer token you have provided in the 'Authorization' header has expired. Please obtain a new one."}}
Status Code - 401
Invalid Authorization header bearer token value
{"error":{"type":"invalid_authorization","message":"The bearer token you have provided in the 'Authorization' header is invalid."}}
Status Code - 400
Returned if no group id or external reference is passed in the body.
No group id or external reference supplied
{"error":{"type":"no_group","message":"You must either provide a group id or group external reference in the request body."}}
Status Code - 400
Returned if both a group id and group_external_ref are provided
Both group id and external ref provided for the unit post-multiple operation
{"error":{"type":"both_group_identifiers_provided","message":"You have provided both a group id and group external reference for the create/update units operation. Please only provide one of the two."}}
Status Code - 401
Returned if the authenticated API user does not have access to the requested group.
No access to the provided group
{"error":{"type":"no_access_to_group","message":"You do not have access to the group you have provided."}}
Status Code - 404
Returned if no group for the provided group ID is found
Group with provided ID not found
{"error":{"type":"group_not_found","message":"We could not find a group with the ID you have provided."}}
