OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate data and related resources. Specifically, for the Estate - Update operation, it updates an existing estate record in the OnOffice system by sending new or modified property data.

Typical use cases include:

  • Synchronizing updated property details from another system into OnOffice.
  • Automating updates of estate listings after changes such as price adjustments, description edits, or address corrections.
  • Bulk updating multiple estates programmatically within a workflow.

For example, you might update an estate's title, type (e.g., apartment or house), marketing type (sale or rent), price, living space, number of rooms, and location details like postal code and city.

Properties

Name Meaning
ID The unique identifier of the estate record to update. This is required to specify which estate to modify.
Data A JSON object containing the fields and values to update on the estate. Typical fields include:
- objekttitel: Title of the estate (e.g., "Moderne Wohnung im Zentrum")
- objektart: Property type (e.g., "wohnung" for apartment)
- vermarktungsart: Marketing type ("kauf" for sale, "miete" for rent)
- kaufpreis: Purchase price
- wohnflaeche: Living area in square meters
- anzahl_zimmer: Number of rooms
- plz: Postal code
- ort: City
- strasse: Street name
- hausnummer: House number
- objektbeschreibung: Description of the estate

Output

The node outputs a JSON object representing the result of the update operation. The structure includes:

  • success: Boolean indicating if the update was successful.
  • resourceType: The resource affected, here always "estate".
  • operation: The operation performed, here "update".
  • data: The updated estate data returned from the API, reflecting the changes.
  • message: Optional message from the API about the update status.
  • rawResponse: The full raw response from the OnOffice API for debugging purposes.

If the update fails, the output will contain error information including the error message and optionally the API error response.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Invalid JSON in Data field: If the JSON provided in the "Data" property is malformed, the node throws an error: "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • API Request Failed: Network issues, invalid credentials, or API downtime can cause request failures. The node outputs the error message and API response if available.
  • Unsupported Resource or Operation: If the resource or operation parameters are incorrect or unsupported, the node throws errors indicating the unsupported action.
  • API Action Errors: If the API returns an error code, the node surfaces the API's error message. Check that the provided data fields conform to the API's expected schema and constraints.
  • Continue On Fail: Enabling this option allows the node to continue processing subsequent items even if one item fails.

Links and References

Discussion