OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate resource and the Update operation, it updates an existing estate record by sending new data to the OnOffice system. This is useful in scenarios where you need to modify details of a property listing, such as updating descriptions, prices, or other metadata.

Practical examples include:

  • Updating the status or details of a property after a client request.
  • Correcting or enriching estate information based on new inputs.
  • Automating bulk updates of estate records from external systems.

Properties

Name Meaning
ID The unique identifier of the estate record to update. This is required to specify which estate will be modified.
Data A JSON object containing the fields and values to update on the estate record. This should be valid JSON representing the changes to apply.

Output

The node outputs a JSON array where each item corresponds to an input item processed. For the Update operation on Estate, the output JSON 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 response data returned from the OnOffice API about the updated estate.
  • message: A message from the API confirming the update status.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "update",
  "data": { /* updated estate data from API */ },
  "message": "Record updated successfully"
}

No binary data output is produced by this node.

Dependencies

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

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 before running.
  • Filter parsing errors: Although not directly relevant to Update, other operations use filters that must be valid JSON; invalid filters cause similar errors.
  • API errors: If the OnOffice API returns an error, the node surfaces the message prefixed with "OnOffice API error:". Check the API token validity, permissions, and the correctness of the request payload.
  • Network issues: Network connectivity problems result in errors starting with "Network error:". Verify internet access and API endpoint availability.
  • Missing or incorrect ID: The ID property is required for update operations. Omitting or providing an invalid ID will cause the API call to fail.

Links and References


This summary focuses exclusively on the Estate resource's Update operation as requested.

Discussion