TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including users. Specifically, the "User Delete" operation allows you to delete a user resource by specifying its unique ID. This is useful in scenarios where you need to programmatically remove user accounts from your TeleFlow system, such as automating cleanup of inactive users or managing user lifecycle within workflows.

Practical example: Automatically deleting a user after they leave an organization or when their account is no longer needed, ensuring your TeleFlow environment stays up-to-date without manual intervention.

Properties

Name Meaning
ID The unique identifier of the user 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).

Output

The output JSON contains the response from the TeleFlow API after attempting to delete the user. Typically, this will be a confirmation of deletion or relevant status information returned by the API. No binary data is output by this operation.

Example output structure:

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

(Note: Actual response fields depend on the TeleFlow API's delete endpoint.)

Dependencies

  • Requires an active connection to the TeleFlow API.
  • Needs an API authentication token or key configured in the node credentials.
  • The base URL for the TeleFlow API must be set in the node credentials.

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 provide a valid user ID.
  • API Errors: If the API returns an error (e.g., user 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.
  • Network Issues: Connectivity problems to the TeleFlow API will cause request failures. Verify network access and API endpoint correctness.
  • Permission Issues: Ensure the API key used has sufficient permissions to delete user resources.

Links and References

Discussion