OnOffice icon

OnOffice

Consume OnOffice API

Actions15

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Address - Create operation, it allows users to create a new address record in the OnOffice system by providing detailed contact information.

Common scenarios where this node is beneficial include:

  • Adding new client or contact addresses into a real estate CRM.
  • Automating the creation of address records from form submissions or other data sources.
  • Synchronizing external address data into OnOffice for further processing or marketing.

For example, you might use this node to automatically add a new prospective tenant's contact details when they fill out an inquiry form on your website.

Properties

Name Meaning
Data JSON object containing the address details to create. The JSON should include fields such as:
- Form of Address (e.g., "Herr")
- First Name
- Last Name
- Email
- Phone 1
- Street
- Postal Code
- City
- Country

Example of the Data property value:

{
  "Anrede": "Herr",
  "Vorname": "Max",
  "Name": "Mustermann",
  "Email": "max.mustermann@example.com",
  "Telefon1": "+49 123 456789",
  "Strasse": "Musterstraße",
  "Plz": "12345",
  "Ort": "Musterstadt",
  "Land": "Deutschland"
}

Output

The node outputs a JSON object representing the result of the create operation. The output includes:

  • success: Boolean indicating if the creation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "create".
  • data: The created address data returned by the API, which may include the newly assigned ID and other metadata.
  • message: A status message from the API confirming the creation.

Additionally, the node provides debug information including the raw API response and the request sent.

No binary data output is involved in this operation.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node communicates with the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the OnOffice API credentials within n8n is necessary before using this node.

Troubleshooting

  • Invalid JSON in Data Property: If the Data field contains invalid JSON, the node will throw an error stating "Data must be a valid JSON". Ensure that the JSON syntax is correct.
  • API Request Failed: Network issues or incorrect API credentials can cause the request to fail. The node returns an error message with details. Verify API credentials and network connectivity.
  • API Action Errors: If the API returns an error code, the node surfaces the error message from the API. Check the provided data fields for correctness and completeness.
  • Unsupported Resource or Operation: Using unsupported combinations of resource and operation will cause errors. Confirm that "address" resource supports the "create" operation.

Links and References

Discussion