OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

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

Typical use cases include:

  • Keeping contact information up-to-date for clients or contacts related to real estate properties.
  • Automating updates of address details from external systems or forms into OnOffice.
  • Synchronizing address changes across multiple platforms via n8n workflows.

For example, you might update a contact's phone number and email after receiving updated info from a CRM or form submission.

Properties

Name Meaning
ID The unique identifier of the address record to update. This is required to specify which address to modify.
Data JSON object containing the fields and values to update on the address record. Example fields include form of address, first name, last name, email, phone numbers, street, postal code, city, and country.

The Data property expects a valid JSON structure representing the address fields to be updated. For instance:

{
  "Anrede": "Herr",
  "Vorname": "Max",
  "Name": "Mustermann",
  "Email": "max.mustermann@example.com",
  "Telefon1": "+49 123 456789",
  "Strasse": "Musterstraße",
  "Plz": "12345",
  "Ort": "Musterstadt",
  "Land": "Deutschland"
}

Output

The node outputs a JSON object summarizing the result of the update operation. The output includes:

  • success: Boolean indicating if the update was successful.
  • resourceType: The resource affected, here always "address".
  • operation: The operation performed, here "update".
  • data: The updated address data returned from the API (may be empty or partial depending on API response).
  • message: A status message from the API confirming the update.
  • rawResponse: The full raw API response for debugging purposes (included when debug mode is enabled).

If the update fails, the output will contain error details including an error message and possibly the API error response.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node makes 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 OnOffice API credentials in n8n is necessary before using this node.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the Data field is malformed, the node throws an error indicating that the data must be valid JSON. Ensure the JSON syntax is correct.
  • Missing or incorrect ID: The ID property is required. Omitting it or providing an invalid ID will cause the API to fail to locate the address record.
  • API errors: Errors returned from the OnOffice API are surfaced with messages such as "OnOffice API action error" or "OnOffice API error". These may indicate issues like invalid credentials, insufficient permissions, or invalid data fields.
  • Network or connectivity issues: If the HTTP request fails, the node reports "API Request Failed" with the underlying error message.
  • To continue processing other items despite errors, enable the node's "Continue On Fail" option.

Links and References

  • OnOffice API Documentation (official API docs, for detailed field definitions and capabilities)
  • n8n documentation on HTTP Request Node (for understanding how HTTP calls work in n8n)
  • General JSON formatting guides to ensure valid input data.

This summary focuses on the Address resource's Update operation as requested, based solely on static analysis of the provided source code and property definitions.

Discussion