Skip to main content
PATCH
Update Comp Set

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 updating comp set settings. Send at least one field besides account_id. Integer fields also accept integer strings.

account_id
required

ApartmentIQ account ID used to set the request account context.

name
string

New name. Leading and trailing spaces are removed. Must not be blank and must be unique in the account.

Required string length: 1 - 150
min_floorplan
integer
Required range: 0 <= x <= 5
max_floorplan
integer

Must be at least min_floorplan.

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

Target number of properties including the subject. Changing it does not add or remove comps.

Required range: 2 <= x <= 51

Response

The comp set was updated.

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.