OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Update operation, it updates an existing address record in the OnOffice system by sending new data for that address identified by its ID.

Common scenarios include:

  • Keeping address records up-to-date when contact details or location information changes.
  • Automating bulk updates of address data from other systems.
  • Synchronizing address information between OnOffice and external CRMs or databases.

Example: You have a contact's address stored in OnOffice, and you want to update their email and phone number programmatically whenever they change in your CRM.

Properties

Name Meaning
ID The unique identifier of the address record to update. This is required to specify which address to modify.
Data A JSON object containing the fields and values to update on the address record. This must be valid JSON representing the new data for the address.

Output

The node outputs a JSON array where each item corresponds to one input item processed. For the Update operation on Address, the output JSON has the following structure:

{
  "success": true,
  "resourceType": "address",
  "operation": "update",
  "data": { /* updated address data returned from OnOffice API */ },
  "message": "..." // status message from the API
}
  • success: Indicates if the update was successful.
  • resourceType: Always "address" for this operation.
  • operation: Always "update".
  • data: Contains the updated address record data as returned by the API.
  • message: A textual message from the API about the operation result.

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret (configured via credentials).
  • The node sends HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper API credentials must be configured in n8n before use.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the Data field is malformed, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Missing or incorrect ID: The ID field is required to identify the address to update. Omitting it or providing an invalid ID will cause errors.
  • API errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API credentials and the validity of the data sent.
  • Network issues: Network connectivity problems result in errors like "Network error: ". Verify internet access and API endpoint availability.
  • Filter parsing errors: Although not directly relevant for update, other operations may require valid JSON filters; invalid JSON there also causes errors.

Using the "Continue On Fail" option allows processing multiple items even if some fail.

Links and References

Discussion