Skip to main content
POST
Create Property

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

address
object
required
type
string
required
currentValue
number
required
appraisalDate
string | null
required
insured
boolean | null
required
loanId
string
personId
string
name
string
mlsNumber
string
purchasePrice
number
appraisedValue
number
occupancyType
string
zoning
string
propertyCharacteristics
object
insuranceProvider
string
insurancePolicyNumber
string

Response

The created property.

The created property.

id
string
required
address
object

Present unless the request's fields leaves it out.

type
string

Present unless the request's fields leaves it out.

name
string

Present unless the request's fields leaves it out.

mlsNumber
string

Present unless the request's fields leaves it out.

purchasePrice
number | null

Present unless the request's fields leaves it out.

currentValue
number

Present unless the request's fields leaves it out.

appraisedValue
number | null

Present unless the request's fields leaves it out.

appraisalDate
string | null

Present unless the request's fields leaves it out.

occupancyType
string

Present unless the request's fields leaves it out.

zoning
string

Present unless the request's fields leaves it out.

propertyCharacteristics
object | null

Present unless the request's fields leaves it out.

insured
boolean | null

Present unless the request's fields leaves it out.

insuranceProvider
string

Present unless the request's fields leaves it out.

insurancePolicyNumber
string

Present unless the request's fields leaves it out.

created
string | null

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

numberOfUnits
number | null

Present unless the request's fields leaves it out.

mixedUse
boolean | null

Present unless the request's fields leaves it out.

manufacturedHome
boolean | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.