TeleFlow icon

TeleFlow

Interact with TeleFlow API

Overview

This node interacts with the TeleFlow API to manage various resources, including Email Templates. Specifically, for the Email Template - Delete operation, it deletes an existing email template identified by its unique ID. This is useful in scenarios where you need to programmatically remove outdated or unwanted email templates from your TeleFlow system as part of workflow automation.

Practical examples include:

  • Automatically cleaning up email templates that are no longer used.
  • Managing email templates lifecycle within a larger automated provisioning or deprovisioning process.
  • Integrating TeleFlow email template management into broader business workflows.

Properties

Name Meaning
ID The unique identifier of the email template to delete. This is required to specify which template 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 specified email template. Typically, this will be a confirmation of deletion or an error message if the operation failed.

Example output structure:

{
  "success": true,
  "message": "Email template deleted successfully"
}

or, in case of failure:

{
  "error": "ID is required for delete operation"
}

No binary data output is produced by 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.
  • The node uses HTTP DELETE requests to the endpoint /emailTemplates/{id} to perform deletions.

Troubleshooting

  • Missing ID Error: If the "ID" property is not provided, the node throws an error stating that the ID is required. Ensure the ID of the email template to delete is correctly set.
  • API Authentication Errors: If the API key or base URL is incorrect or missing, the node will fail to authenticate. Verify the credential configuration.
  • Resource Not Found: If the specified ID does not exist, the API may return a not found error. Confirm the ID is valid and exists in TeleFlow.
  • Network Issues: Connectivity problems can cause request failures. Check network access to the TeleFlow API endpoint.

Links and References

Discussion