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 or 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 will be modified.
Data JSON object containing the fields and values to update on the address record. Example fields include: "Anrede" (form of address), "Vorname" (first name), "Name" (last name), "Email", "Telefon1" (phone), "Strasse" (street), "Plz" (postal code), "Ort" (city), and "Land" (country).

The Data property must be valid JSON representing the address fields to update.

Output

The node outputs a JSON object describing the result of the update operation. The structure 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.
  • message: A status message from the API response.
  • rawResponse: The full raw API response for debugging purposes.
  • debug: A flag indicating debug info is included.

If the API call fails, the output contains error details including the error message and any error response data.

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node sends 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.

Troubleshooting

  • Invalid JSON in Data: If the Data property contains invalid JSON, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • API Request Failed: Network issues or incorrect credentials can cause failures. Check your API token and secret are correctly configured.
  • API Action Errors: If the API returns an error code, the node surfaces the message, e.g., "OnOffice API action error: ". Verify that the ID exists and the data fields conform to API requirements.
  • Unsupported Resource or Operation: Using unsupported combinations will throw errors indicating the resource or operation is not supported.
  • Use the "Continue On Fail" option in n8n to handle errors gracefully within workflows.

Links and References

Discussion