Automatic enabled-module adapters

Use the HMO Manager adapter

Owned HMO/property tenancy information where adapters find compatible tables. The guide then takes you through the correct route, the checks to complete before making changes, the workflow in order, and the evidence to review afterwards.

Audience: CRM administrators, integration developers, external portal backend teams and security reviewersPermission: Valid short-lived client sessionModule v1.0.0
Jump to steps
Where to goExternal backend → GET /portal_api/me or supported workspace endpoint
Before you start
  • Verify the module is active and use the exact navigation shown above.
  • Use an account with the stated module and core CRM permissions.
  • Use known test records when changing statuses, visibility, saved filters or global navigation.

What you’ll accomplish

Owned HMO/property tenancy information where adapters find compatible tables. The instructions below follow the supplied module’s live menu, controller, form, model and JavaScript flow.

Follow these steps

  1. Go to External backend → GET /portal_api/me or supported workspace endpoint.
  2. Find the record, endpoint, field or action used to use the hmo manager adapter.
  3. Complete the displayed values exactly as described in this guide.
  4. Select the available save, submit, send, upload, create, update or confirm action.
  5. Return to the related register, portal, activity log or API response and verify the expected result.

Fields and options to review

AdapterHMO Manager
DataOwned HMO/property tenancy information where adapters find compatible tables.

Rules the system enforces

  • The underlying module must be active and its expected tables/fields available.
  • Only records owned by the authenticated client/contact and allowed for portal visibility are returned.

How to confirm it worked

  • The use the hmo manager adapter workflow completes without a validation, permission, ownership or availability error.
  • The related record, portal view, activity entry, notification log or API response shows the expected state.
  • Client-visible, public and API data remains limited to the code-backed ownership and visibility rules.

Security, privacy and operational checks

  • Use controlled test records and non-production credentials before wider rollout.
  • Grant least privilege and protect secure links, personal data, uploaded files, signatures, API tokens, allowed origins and server IPs.