sevDesk icon

sevDesk

Consume the sevDesk API

Overview

This node integrates with the sevDesk API to manage various resources, including Contact Custom Field Settings. Specifically, the "Update" operation for the Contact Custom Field Setting resource allows users to modify existing custom field settings associated with contacts in sevDesk. This is useful when you need to change metadata such as the name or description of a custom field setting without recreating it.

Practical examples include:

  • Renaming a contact custom field setting to better reflect its purpose.
  • Updating the description to provide clearer context for other users or integrations.

Properties

Name Meaning
Contact Custom Field Setting ID The unique identifier of the contact custom field setting to update (required).
Update Fields A collection of fields to update on the contact custom field setting:
- Name The new name for the custom field setting (required if updating).
- Description An optional description providing additional details about the custom field setting.

Output

The node outputs an array of JSON objects representing the results of the update operations performed. Each object corresponds to one input item processed and contains the updated 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 involved in this operation.

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.
  • The node depends on internal resource management and validation modules bundled within the node's codebase.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Contact Custom Field Setting ID will result in an error from the API.
    • Omitting required fields like the "Name" in the update collection may cause validation errors.
    • Network or authentication failures can prevent successful API calls.
  • Error messages:

    • Errors returned by the API are captured and included in the output if "Continue On Fail" is enabled.
    • Typical error messages might indicate missing parameters, invalid IDs, or permission issues.
  • Resolution tips:

    • Verify that the Contact Custom Field Setting ID exists and is correct.
    • Ensure all required update fields are provided.
    • Confirm that the API key credential is valid and has sufficient permissions.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion