OmniFlow icon

OmniFlow

Consume OmniFlow API
Join our community

Actions20

Overview

This node interacts with the OmniFlow API to manage contacts and their communication preferences. Specifically, the "Edit Do Not Contact List" operation allows users to add or remove a contact from the Do Not Contact (DNC) list for specified communication channels such as Email or SMS. This is useful in scenarios where compliance with communication regulations is required, or when managing user preferences to avoid sending unwanted messages.

Practical examples include:

  • Adding a contact to the email DNC list after they unsubscribe.
  • Removing a contact from the SMS DNC list if they opt back in.
  • Recording reasons and comments for DNC status changes to maintain audit trails.

Properties

Name Meaning
Authentication Method of authentication: either using stored credentials or OAuth2 token.
Contact ID The unique identifier of the contact to modify in the Do Not Contact list.
Action Whether to "Add" the contact to or "Remove" the contact from the Do Not Contact list.
Channel Communication channel affected by the DNC action; options are "Email" or "SMS".
Additional Fields Optional extra information when adding to the DNC list:
- Reason To Do Not Contact Reason for adding to the DNC list; options are "Unsubscribed", "Bounced", or "Manual".
- Comments Text field to describe details about the DNC entry (e.g., why the contact was added).

Output

The output JSON contains the updated contact object returned from the OmniFlow API after performing the DNC list edit. It includes all relevant contact fields reflecting the new Do Not Contact status.

If the user sets the option to receive raw data as false (not shown here but available in other operations), the output will be simplified to only the core contact fields.

No binary data is involved in this operation.

Dependencies

  • Requires an active OmniFlow API connection configured in n8n, authenticated either via credentials or OAuth2.
  • The node depends on the omniflowApiRequest helper function to communicate with the OmniFlow REST API.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Invalid Contact ID: If the provided Contact ID does not exist or is malformed, the API will likely return an error. Verify the Contact ID before running the node.
  • Unauthorized Access: Ensure that the API credentials or OAuth2 token have sufficient permissions to modify contact DNC lists.
  • Invalid Action or Channel: Only "add" or "remove" actions and "email" or "sms" channels are supported. Using unsupported values will cause errors.
  • API Errors: Network issues or API downtime can cause request failures. Check connectivity and OmniFlow service status.
  • JSON Validation: Although not directly applicable here, other operations validate JSON input strictly; invalid JSON will throw errors.

To resolve errors, check the error message returned in the node output, verify input parameters, and confirm API access rights.

Links and References

Discussion