Skip to main content
POST
Onboard property

Authorizations

x-api-key
string
header
required

A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.

Body

application/json
requestId
string
required
Maximum string length: 200
address
object
required
type
enum<string>
required
Available options:
house,
flat,
maisonette,
bungalow,
hmo,
studio,
other
letAs
enum<string>
required
Available options:
whole,
rooms
beds
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
furnishing
enum<string> | null
required
Available options:
unfurnished,
part_furnished,
furnished
occupierContactId
string | null
required
rooms
object[]
required
occupiedFrom
string | null
required
landlordContactId
string | null
required
landlordCompanyId
string | null
required
owners
object[]
required
responsibilities
object[]
required
repairAuthority
object | null
required
emailLandlordToConfirm
boolean
required

Response

Success

propertyId
string
required
units
object[]
required
setupRevision
required
repairAuthority
object | null
required
confirmation
object
required
replayed
boolean
required