POST
/
listing
/
Authorization
string
default: "none"required

The authentication token for your request

​
Body

group_id
string
default: "none"required

The id of a group to use for the listing create/update operation.

Used for:

  • searching for an existing listing record to update
  • setting group assignment for a newly created listing record
unit_id
string
default: "none"

The id of the unit you want to associate the newly created or updated listing.

If no unit id is specified, a new unit record will be created instead.

amenities
[string]
default: "none"

A list of amenities for the listing to be created or updated.

features
[string]
default: "none"

A list of features for the listing to be created or updated.

finish
string
default: "none"

The tier of finish for the listing to be created or updated.

active_date
date
default: "none"

The date from which the listing should become active.

If this is not provided, it will default ot the current date.

address
object
default: "none"

Address information for the listing to be added or updated.

bathrooms
[object]
default: "none"

A list of bathroom characteristics for each bathroom for the listing to be updated or created.

bedrooms
integer
default: "none"

The number of bedrooms for the listing to be updated or created.

description
string

The description of the listing to be updated or created.

floorplan_url
string

The url to the floorplan for the listing to be updated or created.

image_urls
[string]

A list of urls of images for the listing to be updated or created.

is_flex
boolean

Whether the listing to be updated or created is for a flex apartment or not.

is_furnished
boolean

Whether the listing to be updated or created is furnished or not.

lease_terms
object

A list of the terms for the lease to be updated or created.

move_in_date
date

The move in date for the listing to be updated or created.

sqft
float

The square feet surface for the listing to be updated or created.

tour_url
string

The url to the virtual tour for the listing to be updated or created.

unit_number
string

The number of the unit record associated with the listing to be created or updated.

unit_type
string
required

The type of the unit associated with the listing to be updated or created.

Will be either apartment or studio_apartment.

listing_url
string
required

The url of the listing to be updated or created.

​
Response

success
boolean

Whether the listing update or create operation has been successful.

listing
object

The listing that has just been created or updated.

​
Errors

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 is provided

No group provided for the listing
{
   "error": {
    "type": "no_group_provided",
    "message": "You have not provided a group for the listing."
  }
}

Status Code - 400

Returned if no or wrong unit type is provided

No or wrong unit type provided for the listing
{
   "error": {
    "type": "missing_or_invalid_unit_type",
    "message": "You have not provided a unit type or provided an invalid unit type value for the listing. Please specify a unit type of apartment or studio_apartment."
  }
}

Status Code - 400

Returned if no listing url is provided

No listing url for the listing
{
   "error": {
    "type": "no_listing_url",
    "message": "You have not provided a listing URL for the listing."
  }
}
Create/Update PropertiesSynchronise Listings