capabilities.work

Onboard a property

A 9-step recipe with Arthur Online. We can help you get access.

Recipe · 9 steps

Onboard a property

Create a property, its first unit, a certificate, shared information and a document.

  1. confirmEntity
  2. Look for an existing property at this address before creating one.
  3. createProperty
  4. verifyProperty
  5. Tenancies and viewings attach to units, so a property with no units cannot be let.
  6. fileCertificate
  7. publishGeneralInfo
  8. attachDocument
  9. confirmUnits
What you'll need to have ready
  • entityId: Sent as X-EntityID on every call.
  • property: Property fields as documented on Add Property.
  • unit: Unit fields as documented on Add Unit.
  • certificate: Certificate fields including type and expiry date.
  • generalInfo: title, description, faq_type and the share_* flags.
  • asset: file (base64), mime_type, file_name and the share_* flags.
For your developer

Arazzo workflow arthur-online:onboardProperty, 9 operations: $sourceDescriptions.entitiesApi.listEntities → $sourceDescriptions.propertiesApi.listProperties → $sourceDescriptions.propertiesApi.addProperty → $sourceDescriptions.propertiesApi.viewProperty → $sourceDescriptions.unitsApi.addUnit → $sourceDescriptions.certificatesApi.addCertificateOnProperty → $sourceDescriptions.generalInformationApi.addGeneralInfoForProperty → $sourceDescriptions.assetsApi.createAssetOnProperty → $sourceDescriptions.unitsApi.listUnitsOnProperty. Specs on APIs.io.

More recipes with Arthur Online

Applicant to tenancyMaintenance dispatch