Propertys

Register a new Property (e.g. 'BIG4 Launceston')

Registers a new Property (e.g. 'BIG4 Launceston').

post/properties

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/properties
  • Auth: HTTP bearer

Headers

API-Version'1'

Major API version. Omit or send 1 for the current v1 surface. Retired operations use RFC 9745 Deprecation and RFC 8594 Sunset headers.

Request body

namestring required
typeinteger required
slugstring required
addressstring required
statestring required
country'AU' | 'NZ'
regionstring nullable
latnumber required
lonnumber required
descstring nullable
pmsstring nullable
websitestring uri nullable
emailstring email nullable
phone_freestring nullable
phone_altstring nullable
featuresinteger[] nullable
managementsinteger[] nullable
highlightsstring[] nullable
google_place_idstring nullable

Google Maps Place ID for star ratings

statusstring nullable
visibilitystring
booking_enabledboolean
manual_request_enabledboolean nullable

Whether guests can submit Request to Book. Omission preserves the existing AU default and keeps new NZ catalogue entries directory-only.

Response

Successful Response

idinteger required
namestring required
typeinteger required
slugstring required
addressstring required
statestring required
country'AU' | 'NZ'
regionstring nullable
latnumber required
lonnumber required
descstring nullable required
pmsstring nullable required
websitestring uri nullable required
emailstring email nullable required
phone_freestring nullable required
phone_altstring nullable required
featuresinteger[] nullable
managementsinteger[] nullable
highlightsstring[] nullable
statusstring nullable required
visibilitystring
booking_enabledboolean
register_datestring date-time nullable required
updated_atstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.