sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to manage various resources, including tags. Specifically, the "Update" operation for the "Tag" resource allows users to modify existing tags by specifying their ID and new properties such as the tag's name. This is useful in scenarios where you need to rename or update metadata associated with tags used for categorization or organization within sevDesk.

Practical examples:

  • Renaming a tag to better reflect its purpose.
  • Correcting typos or updating tag names to align with new business terminology.

Properties

Name Meaning
ID The unique identifier of the tag to update. Required to specify which tag will be modified.
Name The new name to assign to the tag.

Output

The node outputs JSON data representing the updated tag object returned from the sevDesk API. This typically includes the tag's ID, updated name, and potentially other metadata fields as provided by the API response.

If an error occurs during the update, the output JSON will contain an error field with the error message.

Dependencies

  • Requires an API key credential for authenticating with the sevDesk API.
  • The base URL for API requests is https://my.sevdesk.de/api/ combined with the API version specified in credentials.
  • The node depends on internal resource management and validation modules bundled within the node implementation.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent tag ID will result in an error from the API.
    • Missing or incorrect API authentication credentials will cause authorization failures.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • Errors returned from the API are captured and included in the output under the error field.
    • If the node is set to continue on failure, it will output the error per item instead of stopping execution.
  • Resolutions:

    • Verify that the tag ID exists and is correct.
    • Ensure the API key credential is valid and has sufficient permissions.
    • Check network connectivity and API endpoint accessibility.

Links and References

Discussion