OnOffice

Consume OnOffice API

Actions12

Estate → Update

AI-generated

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, the "Estate" resource with the "Update" operation allows users to update existing estate records by specifying the record ID and providing new data in JSON format. This is useful for workflows that need to modify property details such as title, description, or other attributes stored in OnOffice.

Practical examples include:

  • Automatically updating estate information when changes occur in an external system.
  • Synchronizing property details from a CRM or ERP into OnOffice.
  • Bulk updating multiple estates with new data via n8n workflows.

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 record. Must be valid JSON representing the updated estate data.

Output

The node outputs a JSON object 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: Contains the updated estate data returned from the API.
  • message: Optional message from the API status.

Example output JSON:

{
  "success": true,
  "resourceType": "estate",
  "operation": "update",
  "data": {
    /* Updated estate record fields */
  },
  "message": "Record updated successfully"
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret credential for authenticating with the OnOffice API.
  • The node uses HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/v1.
  • Proper configuration of the API credentials in n8n is necessary for successful execution.

Troubleshooting

  • Invalid JSON in Data: If the "Data" property contains invalid JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Missing or Incorrect ID: The "ID" field is required. Omitting it or providing an incorrect ID will cause the API call to fail.
  • 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 errors are reported as "Network error: ". Verify network connectivity and API endpoint accessibility.
  • Unsupported Operation or Resource: The node validates the resource and operation; unsupported combinations will raise errors.

Links and References

Discussion