onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to manage address/contact data. Specifically, the Update Address operation allows users to modify details of an existing contact or address record in their onOffice system. This is useful for keeping contact information current, such as updating phone numbers, email addresses, or postal details.

Common scenarios include:

  • Updating client contact information after receiving new details.
  • Correcting or adding missing address fields for contacts.
  • Automating synchronization of contact updates from other systems into onOffice.

Example: A real estate agent uses this node to update a client's phone number and email address automatically when changes are made in a CRM system.

Properties

Name Meaning
Address ID The unique identifier of the address/contact to update.
Fields Collection of address fields to update. Includes:
  Salutation Salutation for the contact. Options: Mr, Ms, Company
  First Name First name of the contact.
  Last Name Last name of the contact.
  Email Email address of the contact.
  Phone Phone number of the contact.
  Street Street name of the contact's address.
  Postal Code Postal code of the contact's address.
  City City where the contact is located.
  Country Country where the contact is located. Default is "Deutschland".
  User User responsible for this contact (likely an internal assignment).

Output

The node outputs JSON data representing the updated address record(s) returned by the onOffice API. The structure includes all fields of the updated contact/address, along with a resourceType property set to "address" to identify the type of data.

If no results are found or the response cannot be parsed, the output will contain a success message with the raw API response.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • Requires proper configuration of the API token and secret to generate HMAC signatures for secure requests.

Troubleshooting

  • Missing Credentials Error: If no API credentials are provided, the node throws an error. Ensure that a valid API key and secret are configured.
  • Invalid Resource or Operation: If the resource or operation parameters are incorrect, the node will throw an error indicating invalid input.
  • API Errors: If the onOffice API returns an error status code, the node surfaces the API error message. Check the API token validity and request parameters.
  • Parsing Issues: If the response format changes or is unexpected, the node may fail to parse results. Verify the API response structure.
  • Required Fields: For update operations, ensure the Address ID is provided and at least one field to update is specified.

Links and References

Discussion