OnOffice

Consume OnOffice API

Actions15

Address Actions
Estate Actions
Agent Log Actions
- Create
Relation Actions
IDs From Relation Actions
- Get
Task Actions
- Create

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, the Estate - Update operation allows users to update existing estate records by specifying the estate's ID and providing new data in JSON format. This is useful for keeping property listings current, such as updating prices, descriptions, or other attributes.

Common scenarios include:

Real estate agencies updating property details after renovations.
Automated workflows that sync updated property information from external systems.
Correcting or enriching existing estate records with additional data.

Example: Updating an apartment listing’s price and description to reflect recent changes.

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. Example fields include title, type, marketing type, price, living space, number of rooms, postal code, city, street, house number, and description.

The Data property expects a valid JSON string representing the estate attributes to be updated. For example:

{
  "objekttitel": "Moderne Wohnung im Zentrum",
  "objektart": "wohnung",
  "vermarktungsart": "kauf",
  "kaufpreis": 250000,
  "wohnflaeche": 80,
  "anzahl_zimmer": 3,
  "plz": "50667",
  "ort": "Köln",
  "strasse": "Hauptstraße",
  "hausnummer": "12",
  "objektbeschreibung": "Schöne, moderne Wohnung im Zentrum."
}

Output

The output JSON contains the result of the update operation with the following structure:

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 by the API (may be empty or partial depending on API response).
message: Optional message from the API about the update status.
Additional metadata may be included for debugging or raw API response.

If the update fails, the output will contain error details including an error message.

Dependencies

Requires an API authentication token and secret credential for 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.

Troubleshooting

Invalid JSON in Data property: If the JSON provided in the Data field 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. Check API credentials and network connectivity.
API action errors: If the API returns an error code, the node surfaces the message from the API. Verify that the estate ID exists and the data fields are valid according to the OnOffice API specification.
Unsupported operation/resource: Errors occur if the resource or operation parameters are incorrect or unsupported.
Use the node’s debug output (debug: true) to inspect raw API requests and responses for troubleshooting.

Links and References

OnOffice API Documentation (official API docs, for detailed field definitions and capabilities)
n8n documentation on Creating Custom Nodes (for understanding node development concepts)

This summary focuses on the Estate resource's Update operation based on the provided source code and properties.

OnOfficeInstall