TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including tenants. Specifically, the "Delete" operation for the "Tenant" resource allows users to remove a tenant by its unique identifier. This is useful in scenarios where you need to programmatically clean up or decommission tenants from your TeleFlow system, such as automating tenant lifecycle management or integrating tenant deletion into broader workflows.

For example, if you have an automated process that deactivates clients or projects, this node can be used to delete the associated tenant record in TeleFlow without manual intervention.

Properties

Name Meaning
ID The unique identifier of the tenant to delete. This is required to specify which tenant to remove.
Fields Optional field-value pairs to include in the request for more specific queries (not typically used in delete).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the tenant. Typically, this will confirm whether the deletion was successful or provide details about the deleted tenant. The exact structure depends on the API's response but generally includes status or confirmation data.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The node expects the base URL of the TeleFlow API to be configured in the credentials.
  • Network access to the TeleFlow API endpoint is necessary.

Troubleshooting

  • Missing ID: If the "ID" property is not provided, the node throws an error stating that the ID is required for the delete operation. Ensure you supply a valid tenant ID.
  • API Errors: If the API returns an error (e.g., tenant not found, permission denied), the node will throw an error unless "Continue On Fail" is enabled, in which case it outputs the error message in the JSON.
  • Authentication Issues: Failure to authenticate due to invalid or missing API credentials will cause the HTTP request to fail.
  • Network Issues: Connectivity problems to the TeleFlow API endpoint will result in errors; verify network and endpoint accessibility.

Links and References

Discussion