onOffice

Interact with onOffice API

Overview

This node integrates with the onOffice API to manage address records. Specifically, the Update Address operation allows users to modify existing address entries by specifying the address ID and the fields to update in JSON format.

Common scenarios where this node is useful include:

  • Updating contact details such as email or phone number for an existing address.
  • Correcting or adding missing information in address records.
  • Automating bulk updates of address data within workflows.

For example, you might use this node to update a client's email and phone number after receiving new contact information.

Properties

Name Meaning
Address ID The unique identifier of the address record to update.
Update Data A JSON object containing the address fields to update and their new values. For example: {"Email": "newemail@example.com", "Telefon1": "+49 123 456789"}

Output

The node outputs the response from the onOffice API after attempting to update the address. The output is a JSON object representing the updated address resource or the API's confirmation message.

If multiple items are returned (not typical for update), they are spread into the output array; otherwise, a single JSON object is returned.

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 sends POST requests to the /api.php endpoint of the onOffice API.
  • The user must have appropriate permissions to modify address records in onOffice.

Troubleshooting

  • Invalid Address ID: If the provided Address ID does not exist or is incorrect, the API will likely return an error. Verify the ID before running the node.
  • Malformed JSON in Update Data: The updateData property must be valid JSON. Syntax errors will cause the node to fail. Use proper JSON formatting.
  • API Authentication Errors: Ensure that the API key credential is correctly set up and has sufficient rights.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the onOffice API endpoint.
  • 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