OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage contacts and their associations with segments, campaigns, companies, and emails. Specifically, for the Contact Segment - Remove operation, it removes a specified contact from a given segment.

Common scenarios where this node is useful include:

  • Managing marketing or sales contact lists by dynamically removing contacts from specific segments based on workflow conditions.
  • Automating contact segmentation cleanup when contacts no longer meet criteria for a segment.
  • Integrating with CRM or marketing automation systems to keep contact segments up-to-date without manual intervention.

Example: Automatically remove a contact from a "Newsletter Subscribers" segment if they unsubscribe via a form submission.

Properties

Name Meaning
Authentication Method of authentication to use: either Credentials (API key) or OAuth2 token.
Contact ID The unique identifier of the contact to be removed from the segment.
Segment Name or ID The target segment from which the contact will be removed. Can be selected from a list or set via expression.

Output

The output JSON contains the response from the OmniFlow API after attempting to remove the contact from the segment. Typically, this includes details about the contact and confirmation of the removal action.

The structure is an array of objects representing the updated contact data returned by the API. If the operation fails and "Continue On Fail" is enabled, the output will contain an error message in the json.error field.

No binary data is produced by this operation.

Dependencies

  • Requires access to the OmniFlow API.
  • Requires either an API key credential or OAuth2 authentication configured in n8n.
  • The node uses internal helper functions to make HTTP requests to OmniFlow endpoints.

Troubleshooting

  • Error: Invalid Contact ID or Segment ID
    Ensure that the Contact ID and Segment ID provided are correct and exist in OmniFlow. Use the load options dropdown to select valid segments.

  • Authentication Errors
    Verify that the API credentials or OAuth2 tokens are correctly configured and have sufficient permissions.

  • API Rate Limits or Network Issues
    Temporary network failures or rate limiting by OmniFlow may cause errors. Retry or check OmniFlow service status.

  • Invalid JSON or Expression Errors
    When using expressions for Segment ID, ensure the expression syntax is correct and resolves to a valid segment ID.

Links and References

Discussion