sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage various resources, including Contact Custom Fields. Specifically, the "Update" operation for the Contact Custom Field resource allows users to modify existing custom fields associated with contacts in sevDesk. This is useful when you need to change the value or settings of a custom field without creating a new one.

Practical examples include:

  • Updating a custom field value that tracks additional contact information such as membership status or customer tier.
  • Modifying the linked contact or the custom field setting associated with a particular custom field entry.

Properties

Name Meaning
Contact Custom Field ID The unique identifier of the Contact Custom Field to update. Required to specify which custom field to modify.
Update Fields A collection of fields to update on the Contact Custom Field:
- Contact The contact linked to this custom field, specified by:
-- ID The unique identifier of the contact.
-- Object Name The object type name, defaulting to "Contact".
- Contact Custom Field Setting The custom field setting linked to this custom field, specified by:
-- ID The unique identifier of the custom field setting.
-- Object Name The object type name, defaulting to "ContactCustomFieldSetting".
- Value The new value to assign to the custom field. Required.

Output

The node outputs an array of JSON objects representing the results of the update operations performed. Each item corresponds to one input item processed and contains the updated Contact Custom Field data returned from the sevDesk API.

If an error occurs during processing and the node is configured to continue on failure, the output will include an object with an error property describing the issue for that specific item.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ appended with the API version specified in credentials.
  • Environment configuration validation is performed before execution.
  • Uses internal resource manager and validation schema modules bundled within the node.

Troubleshooting

  • Common issues:

    • Invalid or missing Contact Custom Field ID will cause the update to fail.
    • Providing incomplete or incorrect nested objects (Contact or Contact Custom Field Setting) may result in API errors.
    • Network or authentication failures due to invalid API keys or connectivity issues.
  • Error messages:

    • Errors thrown by the API are caught and can be output per item if "Continue On Fail" is enabled.
    • Typical error messages might include "Resource not found", "Invalid parameter", or authentication errors.
  • Resolution tips:

    • Verify that the Contact Custom Field ID exists and is correct.
    • Ensure all required fields in the "Update Fields" collection are provided.
    • Check API credentials and network connectivity.
    • Enable "Continue On Fail" to handle partial failures gracefully.

Links and References

Discussion