OnOffice

Consume OnOffice API

Actions12

Address → Update

AI-generated

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. The Address - Update operation allows users to update an existing address record by specifying its ID and providing new data in JSON format.

Typical use cases include:

  • Synchronizing address information from external systems into OnOffice.
  • Automating updates of contact or location details for properties.
  • Bulk updating multiple address records in workflows.

For example, you might update an address's email or phone number after receiving updated contact info from a CRM system.

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. For example, {"email":"new.email@example.com","phone":"123456789"}.

Output

The node outputs a JSON object summarizing the result of the update operation:

  • success: Boolean indicating if the update was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "update".
  • data: The updated address data returned from the API.
  • message: A status message from the API confirming the update.

Example output JSON structure:

{
  "success": true,
  "resourceType": "address",
  "operation": "update",
  "data": {
    /* updated address fields */
  },
  "message": "Update successful"
}

No binary data output is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential with token and secret).
  • Uses HTTP POST requests to the OnOffice API endpoint: https://api.onoffice.de/api/v1.
  • Relies on helper functions to generate request IDs, create request bodies, and sign requests with HMAC.

Troubleshooting

  • Invalid JSON in Data property: If the Data field contains malformed JSON, the node will throw an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • Missing or incorrect ID: The ID property is required. Omitting it or providing an invalid ID will cause the API call to fail.
  • API authentication errors: If the API token or secret are missing or invalid, the node will return an authentication error from the OnOffice API.
  • Filter parsing errors: Although not relevant for update, other operations that accept filters require valid JSON; invalid JSON filters will cause errors.
  • Network issues: Network connectivity problems will result in a "Network error" message.
  • API errors: Any error response from the OnOffice API will be surfaced with the message provided by the API.

To resolve these issues:

  • Validate JSON inputs carefully.
  • Confirm the ID corresponds to an existing address.
  • Verify API credentials are correctly set up.
  • Check network connectivity and API availability.

Links and References

Discussion