sevDesk icon

sevDesk

Consume the sevDesk API

Overview

The node integrates with the sevDesk API to perform various operations on different resources. Specifically, for the Contact resource with the Delete operation, it deletes a contact identified by a given Contact ID from the sevDesk system. This is useful in scenarios where you need to programmatically remove outdated or incorrect contact records from your accounting or CRM data managed in sevDesk.

Practical examples include:

  • Automatically cleaning up contacts that are no longer relevant.
  • Removing duplicate contacts during data synchronization workflows.
  • Deleting contacts as part of a customer lifecycle management process.

Properties

Name Meaning
Contact ID The unique identifier (string) of the contact to delete. This property is required.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will be a confirmation response from the sevDesk API indicating whether the deletion was successful. If an error occurs, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the sevDesk API via an API key credential.
  • The node expects the environment configuration to be valid and warns if not.
  • Uses the internal SevDeskResourceManager class to handle API requests.

Troubleshooting

  • Common issues:

    • Invalid or missing Contact ID will cause the API call to fail.
    • Network or authentication errors if the API key is invalid or expired.
    • Attempting to delete a contact that does not exist may return an error from the API.
  • Error messages:

    • Errors returned by the API are captured and included in the output JSON under the error field.
    • If the node is set to continue on failure, it will output the error per item; otherwise, it will stop execution.
  • Resolutions:

    • Verify the Contact ID is correct and exists in sevDesk.
    • Ensure the API key credential is properly configured and has necessary permissions.
    • Check network connectivity and sevDesk service status.

Links and References

Discussion