Skip to main content
PUT
Replace Comps

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

comp_set_id
integer
required

Comp set ID.

Body

application/json

Request contract for replacing a comp set's comps.

account_id
required

ApartmentIQ account ID used to set the request account context.

property_ids
integer[]
required

The complete list of comps you want, up to 50 distinct IDs. Integer strings such as "781266" are accepted. Duplicates are collapsed. An empty list removes every comp. Owned properties are ignored.

Response

The comps were applied. Both lists are empty when nothing changed.

A market survey or research report.

id
integer
required

Comp set ID.

name
string
required
category
enum<string>
required
Available options:
market_survey,
research_report
account_id
integer
required

ApartmentIQ account ID the comp set belongs to.

active
boolean
required
min_floorplan
integer
required

Lowest bedroom count included (0 is studio).

Required range: 0 <= x <= 5
max_floorplan
integer
required

Highest bedroom count included.

Required range: 0 <= x <= 5
target_comp_count
integer
required

The number of properties automatic comp selection fills the comp set to, counting the subject property. 10 means automatic selection adds up to 9 comps. A custom subject is not counted. It is not a limit: comps you add yourself can go past it.

Required range: x >= 0
subject_property
object | null
required

The comp set's subject property. When a comp set has more than one owned property, this is the one with the lowest ID.

comps
object[]
required

Comps sorted by score, highest first. Comps without a score come last.

app_url
string<uri>
required

Link to the comp set in ApartmentIQ.

added_property_ids
integer[]
required

Comps added by this request, ascending.

removed_property_ids
integer[]
required

Comps removed by this request, ascending.