OpenEMM icon

OpenEMM

Consume EMM API

Actions8

Overview

This node integrates with the OpenEMM email marketing platform to manage recipients. Specifically, the Delete Recipient operation removes a recipient from the OpenEMM system by their email address or ID. This is useful for cleaning up your mailing lists, removing unsubscribed users, or managing bounced addresses.

Practical examples:

  • Automatically deleting recipients who have requested removal via a form.
  • Cleaning up test or invalid email addresses from your database.
  • Removing recipients who have been inactive or marked as bounced.

Properties

Name Meaning
Authentication Method of authentication; currently only "Basic" authentication is supported.
Email or ID The email address or numeric ID of the recipient to delete. Must be provided.

Output

The node outputs JSON data representing the result of the delete operation. Typically, this will include confirmation of deletion or an error message if the operation failed.

No binary data output is produced by this operation.

Example output JSON might look like:

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

or in case of failure:

{
  "error": "Recipient not found"
}

Dependencies

  • Requires an API key credential for authenticating with the OpenEMM API using Basic authentication.
  • The node uses HTTP requests to the OpenEMM RESTful API endpoints.
  • No additional environment variables are required beyond the configured API credentials.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent email or ID will cause the delete operation to fail.
    • Network connectivity problems can prevent communication with the OpenEMM API.
    • Incorrect or missing API credentials will result in authentication errors.
  • Error messages and resolutions:

    • "Recipient not found": Verify that the email or ID exists in OpenEMM before attempting deletion.
    • "Authentication failed": Check that the API key credential is correctly configured and valid.
    • "Network error" or timeouts: Ensure the OpenEMM server is reachable and there are no firewall restrictions.

Links and References

Discussion