Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Distribution Lists → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Distribution Lists resource with the Delete Undefined operation, it deletes a distribution list identified by its ID.

Common scenarios where this node is useful include automating the management of distribution lists within Halo PSA, such as removing obsolete or undefined distribution lists programmatically as part of workflow automation.

For example, you might use this node in a workflow that cleans up distribution lists that are no longer needed based on certain criteria, helping maintain an organized and up-to-date contact system.

Properties

Name Meaning
Id The unique identifier (number) of the distribution list to delete. This property is required.

Output

The node outputs JSON data representing the response from the Halo PSA API after attempting to delete the specified distribution list. The structure typically contains confirmation of deletion or error details if the operation failed.

If the operation fails and "Continue On Fail" is enabled, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including:

    • Base URL of the Halo PSA instance
    • Tenant identifier
    • Client ID
    • Client Secret

  • These credentials must be configured in n8n prior to using the node.

  • The node makes HTTP requests to the Halo PSA API endpoints, so network access to the API is necessary.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause the node to throw an error indicating no credentials were returned.
    • Providing an invalid or non-existent distribution list ID will likely result in an API error.
    • Network connectivity problems can cause request failures.

  • Error messages:

    • "No credentials returned!": Ensure that the API credentials are correctly set up in n8n.
    • "Resource Distribution Lists not found" or "Operation Delete Undefined not found for resource Distribution Lists": Indicates misconfiguration of resource or operation parameters.
    • API errors returned from Halo PSA will be included in the output JSON under the error key if "Continue On Fail" is enabled.

  • To resolve errors, verify credentials, confirm the distribution list ID exists, and check network connectivity.

Links and References

Discussion