curl --location --request "POST 'https://api.travtus.com/units/multiple/'" \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
"group_id": "group-id-1",
"units": [
{
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}'
{
"units": [
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}
Properties
Create/Update Properties
This endpoint creates or updates multiple units.
POST
/
units
/
multiple
/
curl --location --request "POST 'https://api.travtus.com/units/multiple/'" \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
"group_id": "group-id-1",
"units": [
{
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}'
{
"units": [
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}
A group must be provided for updating or creating the units.
You can provide either a group id through the
Status Code - 401
Status Code - 401
Status Code - 400
Returned if no group id or external reference is passed in the body.
Status Code - 400
Returned if both a group id and group_external_ref are provided
Status Code - 401
Returned if the authenticated API user does not have access to the requested group.
Status Code - 404
Returned if no group for the provided group ID is found
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.
Header
string
default:"none"
required
The authentication token for your request
Body
string
default:"none"
The id of the group you want to create or update the units for.
string
default:"none"
The external reference of the group you want to create or update the units for.
[object]
default:"none"
required
A list of units to be updated or created
Show unit
Show unit
string
default:"none"
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.
string
default:"none"
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.
boolean
default:"none"
True if the unit is a flex apartment, false if it is not.
integer
default:"none"
The unit’s number of bathrooms.
integer
default:"none"
The unit’s number of bedrooms.
integer
default:"none"
The square feet surface for the unit.
string
default:"none"
The unit’s number.
[object]
default:"none"
object
default:"none"
Address information for the unit to be created or updated.
Show child attributes
Show child attributes
string
The name of the building.
string
required
The first line of the unit’s address.
string
The second line of the unit’s address.
string
The city of the unit’s address.
string
The country of the unit’s address.
string
required
The state in which the unit’s address is located.
string
required
The postal code of the unit’s address.
float
The latitude of the unit’s address.
float
The longitude of the unit’s address.
Response
[object]
The list of units created or updated by the operation along with the most up to date attributes for each unit.Also indicates whether each of the units was succesfully updated or created and a reason for failure, if the update or creat for the unit failed.
Show unit
Show unit
boolean
Indicates whether the update or create operation was successful.
string
The reason for an unsuccesful unit record creation or update. Empty if creation was successful.
string
The internal identifier for the retrieved unit.
string
The external reference for the retrieved unit.
string
The number of the retrieved unit.
boolean
True if the retrieved unit is a flex apartment, false if it is not.
integer
The number of full bathrooms for the retrieved unit.
integer
The number of half bathrooms for the retrieved unit.
integer
The number of bedrooms for the retrieved unit.
integer
The square feet surface for the retrieved unit.
object
The unit’s address.
Show address
Show address
string
The name of the building.
string
required
The first line of the unit’s address.
string
The second line of the unit’s address.
string
The city of the unit’s address.
string
The country in which the unit’s address is located.
string
required
The state in which the unit’s address is located.
string
required
The postal code for the unit’s address.
string
The latitude of the unit’s address.
string
The longitude of the unit’s address.
Errors
Listed below are common errors that may be returned by the endpoint, along with their corresponding status code. Status Code - 400Missing Authorization header
{
"error": {
"type": "missing_authorization",
"message": "Your request does not include an 'Authorization' header with a bearer token for your account."
}
}
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."
}
}
Invalid Authorization header bearer token value
{
"error": {
"type": "invalid_authorization",
"message": "The bearer token you have provided in the 'Authorization' header is invalid."
}
}
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."
}
}
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."
}
}
No access to the provided group
{
"error": {
"type": "no_access_to_group",
"message": "You do not have access to the group you have provided."
}
}
Group with provided ID not found
{
"error": {
"type": "group_not_found",
"message": "We could not find a group with the ID you have provided."
}
}
curl --location --request "POST 'https://api.travtus.com/units/multiple/'" \
--header 'Content-Type: application/json' \
--header 'Authorization: bearer <token>' \
--data-raw '{
"group_id": "group-id-1",
"units": [
{
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}'
{
"units": [
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-1",
"external_ref": "unit-ext-ref-1",
"has_flex_wall": false,
"number_of_bathrooms": 2,
"number_of_bedrooms": 1,
"sqft": 40,
"unit_number": "2",
"bathrooms": [
{
"has_shower_or_bath": false,
"has_sink": true,
"has_toilet": true
},
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 12",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
},
{
"sucess": true,
"failure_reason": "",
"identifier": "unit-id-2",
"external_ref": "unit-ext-ref-2",
"has_flex_wall": false,
"number_of_bathrooms": 1,
"number_of_bedrooms": 1,
"sqft": 20,
"unit_number": "3",
"bathrooms": [
{
"has_shower_or_bath": true,
"has_sink": true,
"has_toilet": true
}
],
"address": {
"building_name": "Building 1",
"address_line_1": "Blvd Street",
"address_line_2": "Appartment 13",
"city": "New York",
"country": "United States",
"state": "New York",
"postal_code": "10001",
"latitude": 40.730610,
"longitude": -73.935242
},
}
]
}