TeleFlow icon

TeleFlow

Interact with TeleFlow API
Join our community

Actions145

Overview

This node interacts with the TeleFlow API to manage various resources, including flows. Specifically, the Flow - Delete operation allows users to delete a flow resource by specifying its unique identifier (ID). This is useful in scenarios where you want to programmatically remove obsolete or unwanted flows from your TeleFlow system as part of an automated workflow.

Practical examples:

  • Automatically deleting flows that are no longer needed after a certain event.
  • Cleaning up test or temporary flows created during development or testing phases.
  • Managing lifecycle of flows by removing them when related resources are deleted.

Properties

Name Meaning
ID The unique identifier of the flow resource to delete. Required for the delete operation.
Fields Optional field-value pairs to include in the request for more specific queries (not used in delete but available for other operations).

Note: For the delete operation on Flow resource, only the ID property is required and relevant.

Output

The output is a JSON object representing the response from the TeleFlow API after attempting to delete the specified flow. Typically, this will confirm whether the deletion was successful or provide details if it failed.

Example structure:

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

or an error message if deletion failed.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the TeleFlow API.
  • The base URL for the TeleFlow API must be configured in the node credentials.
  • The node uses HTTP requests to communicate with the TeleFlow REST API endpoints.

Troubleshooting

  • Missing ID Error: If the ID parameter is not provided, the node throws an error stating "ID is required for delete operation". Ensure the ID of the flow to delete is correctly set.
  • API Authentication Errors: If the API key or base URL is incorrect or missing, requests will fail. Verify credentials configuration.
  • Resource Not Found: If the specified flow ID does not exist, the API may return a 404 error. Confirm the ID is valid.
  • Permission Issues: Insufficient permissions for the API key can cause authorization errors. Check API user rights.
  • 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