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.

Common scenarios where this node is useful include:

  • Automating updates to property listings in a real estate management system.
  • Synchronizing changes made in other systems or forms back to OnOffice.
  • Bulk updating multiple estates with new information such as price changes, descriptions, or status updates.

For example, you might use this node to update the details of a specific estate after receiving updated information from a CRM or a form submission.

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 new data for the estate.

Output

The node outputs a JSON object with the following structure:

  • success: Boolean indicating if the update was successful (true).
  • resourceType: The resource type, here always "estate".
  • operation: The operation performed, here "update".
  • data: Contains the updated estate data returned from the API.
  • message: A message from the API about the update operation.

Example output JSON:

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

If the update fails, the node throws an error with a descriptive message or returns an error object if configured to continue on failure.

Dependencies

  • Requires an active connection to the OnOffice API using an API token and secret (provided via credentials).
  • The node uses HMAC signature authentication for API requests.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

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 before running.
  • Invalid ID: Providing an incorrect or non-existent estate ID will cause the API to return an error. Verify the ID exists in OnOffice.
  • API Errors: Errors returned from the OnOffice API are surfaced with their messages. Common issues include authentication failures (check API token/secret), permission issues, or malformed requests.
  • Network Issues: Network errors during the HTTP request will be reported. Check connectivity and API endpoint availability.
  • Filter Parsing: Although not relevant for update, other operations that accept filters require valid JSON; invalid filters cause errors.

To resolve errors, verify input parameters, ensure valid JSON formatting, and confirm API credentials and permissions.

Links and References

Discussion