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 from the system by specifying its unique identifier. This is useful in scenarios where a tenant is no longer needed or must be decommissioned, such as cleaning up test data or managing organizational changes.

Practical example: If you have a list of tenants and want to automate the removal of certain tenants based on criteria external to TeleFlow, you can use this node to delete those tenants programmatically within an n8n workflow.

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 but available for other operations).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the specified tenant. Typically, this will confirm whether the deletion was successful or provide details if it failed. The structure depends on the API's response but generally includes status information.

No binary data output is involved in this operation.

Example output JSON might look like:

{
  "success": true,
  "message": "Tenant deleted successfully"
}

or, in case of failure:

{
  "error": "Tenant not found"
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the TeleFlow API.
  • The base URL for the TeleFlow API must be set in the credentials configuration.
  • The node uses HTTP methods (DELETE) to communicate with the TeleFlow REST API.

Troubleshooting

  • Missing ID error: If the "ID" property is not provided, the node throws an error stating that the ID is required. Ensure you supply a valid tenant ID.
  • API errors: If the tenant does not exist or cannot be deleted due to permissions or dependencies, the API may return an error message. Check the API response for details.
  • Authentication issues: If the API key or base URL is incorrect or missing, requests will fail. Verify your credential setup.
  • Continue on Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion