onOffice

Interact with onOffice API

Overview

This node integrates with the onOffice API to manage real estate data. Specifically, for the Estate - Update operation, it updates an existing estate record in the onOffice system by sending modified estate data.

Typical use cases include:

  • Automating updates to property listings when details change (e.g., price, description, status).
  • Synchronizing estate information from other systems or databases into onOffice.
  • Bulk updating multiple estates programmatically within workflows.

For example, a user might update the address or features of a property after receiving new information from a client or external source.

Properties

Name Meaning
Estate ID The unique identifier of the estate to update.
Data JSON-formatted string containing the updated estate data fields and values.

Output

The node outputs the response from the onOffice API as JSON. This typically includes confirmation of the update action and may contain the updated estate data or status information returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the onOffice API via an API key credential configured in n8n.
  • The node uses the onOfficeApiRequest helper function to send POST requests to the /api.php endpoint of the onOffice API.
  • Proper permissions on the API key are necessary to perform update operations on estate resources.

Troubleshooting

  • Invalid Estate ID: If the provided Estate ID does not exist or is incorrect, the API will likely return an error indicating the resource was not found. Verify the Estate ID before running the node.
  • Malformed JSON in Data: The Data property must be valid JSON. Errors parsing this field will cause the node to fail. Use JSON validators to ensure correctness.
  • API Authentication Errors: Ensure the API key credential is correctly set up and has sufficient permissions.
  • Network Issues: Connectivity problems to the onOffice API endpoint can cause timeouts or failures.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error messages in the output JSON.

Links and References

Discussion