OpenEMM icon

OpenEMM

Consume EMM API
Join our community

Actions8

Overview

This node integrates with the OpenEMM email marketing platform to update recipient information. Specifically, the "Recipient - Update" operation allows users to modify a recipient's profile fields and manage their subscription status to mailing lists. This is useful for keeping recipient data current, adjusting subscription preferences, or correcting contact details.

Practical examples include:

  • Updating a recipient’s custom profile fields such as name, phone number, or other metadata.
  • Changing a recipient’s subscription status on a specific mailing list (e.g., activating or suspending their subscription).
  • Correcting an email address or associating a recipient with a different mailing list.

Properties

Name Meaning
Authentication Method of authentication; currently supports only "Basic".
Email or ID The email address or numeric ID of the recipient to update. Required.
Manage Subscription Boolean flag indicating whether to update the recipient's subscription binding to a mailing list.
Mailing List Name or ID When managing subscription, specifies the mailing list to which the recipient's subscription status will be changed. Options are loaded dynamically from available mailing lists.
Status Subscription status of the recipient on the specified mailing list. Possible values: Active, Bounced, Opt-Out By Admin, Opt-Out By Recipient, Waiting For Double Opt-In Confirmation, On Blocklist, Temporary Suspended. Default is Active.
Recipient Fields A collection of custom profile fields to update for the recipient. Each field requires selecting a field name or ID (loaded dynamically) and providing a new value.

Output

The node outputs JSON data representing the response from the OpenEMM API after updating the recipient. This typically includes confirmation of the updated recipient data or error information if the update failed.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n for authenticating with the OpenEMM API using Basic authentication.
  • Depends on OpenEMM RESTful API endpoints to perform recipient updates.
  • Dynamic loading of mailing lists and recipient fields requires network access to OpenEMM.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent email or ID will cause the update to fail.
    • Specifying a mailing list that does not exist or is inaccessible will result in errors when managing subscriptions.
    • Incorrect or missing API credentials will prevent successful API calls.
    • Invalid field names or values in recipient fields may cause the API to reject the update.

  • Error messages:

    • Errors returned from the OpenEMM API will be passed through in the node output under an error property if "Continue On Fail" is enabled.
    • Typical errors include authentication failures, resource not found, or validation errors on input data.

  • Resolution tips:

    • Verify the email or ID exists in OpenEMM before attempting updates.
    • Ensure the mailing list ID or name is correct and accessible.
    • Confirm API credentials are valid and have sufficient permissions.
    • Use the dynamic dropdowns to select valid recipient fields and mailing lists to avoid typos.

Links and References

Discussion