sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to create a custom field for a contact. It is useful when you want to add additional, customizable data fields to contacts in your sevDesk account, enabling more tailored and detailed contact records beyond the default fields.

Practical examples include:

  • Adding a custom note or tag specific to a contact.
  • Storing unique identifiers or preferences related to a contact.
  • Extending contact information with business-specific metadata.

Properties

Name Meaning
Additional Fields A collection of fields required to create the custom field:
- Contact The contact to which the custom field will be attached. Contains:
-- ID The unique identifier of the contact.
-- Object Name The object type name, fixed as "Contact".
- Contact Custom Field Setting The setting that defines the custom field's configuration. Contains:
-- ID The unique identifier of the custom field setting.
-- Object Name The object type name, fixed as "ContactCustomFieldSetting".
- Value The value to assign to the custom field for the specified contact.

Output

The node outputs an array of JSON objects representing the response from the sevDesk API after creating the contact custom field. Each output item corresponds to one input item processed.

The json output contains the created custom field data as returned by the API, including identifiers and any metadata provided by sevDesk.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/{apiVersion}, where {apiVersion} is configured via credentials.
  • The node depends on internal resource management and validation modules bundled within the node package.

Troubleshooting

  • Common issues:

    • Missing or invalid API authentication token can cause authorization errors.
    • Providing incomplete or incorrect IDs for Contact or Contact Custom Field Setting will result in API errors.
    • Network connectivity problems may prevent successful API calls.
  • Error messages:

    • Errors returned from the API are captured and included in the output if "Continue On Fail" is enabled.
    • Typical error messages relate to invalid parameters or unauthorized access.
  • Resolution tips:

    • Verify that the API key credential is correctly set up and has sufficient permissions.
    • Ensure all required fields (Contact ID, Custom Field Setting ID, and Value) are provided and valid.
    • Check network connectivity and sevDesk service status.

Links and References

Discussion