OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage campaign contacts, specifically allowing users to add or remove contacts from marketing campaigns. It is useful in scenarios where you want to automate the management of contact lists within campaigns, such as removing a contact who unsubscribed or adding a new lead to a campaign.

For example, you can use this node to:

  • Remove a contact from a specific campaign when they opt out.
  • Add a contact to a campaign after they fill out a form or meet certain criteria.

The "Remove" operation under the "Campaign Contact" resource specifically removes a contact from a given campaign by their contact ID and the campaign's name or ID.

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 campaign.
Campaign Name or ID The campaign from which the contact will be removed. Can be selected from a list or specified via expression.

Output

The output is a JSON array representing the response from the OmniFlow API after attempting to remove the contact from the campaign. Typically, it contains details about the updated campaign contact status or confirmation of removal.

The structure corresponds to the API's response for the removal action and is wrapped per item processed by the node.

No binary data output is produced by this operation.

Dependencies

  • Requires an active OmniFlow API connection, authenticated either via API credentials or OAuth2.
  • The node depends on the OmniFlow API endpoints for campaigns and contacts.
  • Proper configuration of the API credentials or OAuth2 tokens in n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Contact ID or Campaign ID/name will cause the API call to fail.
    • Authentication errors if the provided credentials or OAuth2 tokens are incorrect or expired.
    • Network or API downtime may result in request failures.
  • Error messages:

    • Errors returned from the OmniFlow API will be thrown by the node. For example, "Contact not found" or "Campaign not found" indicate invalid IDs.
    • "Invalid JSON" error is unlikely here since inputs are simple strings but could occur if expressions resolve incorrectly.
  • Resolutions:

    • Verify that the Contact ID and Campaign ID are correct and exist in OmniFlow.
    • Ensure the API credentials or OAuth2 tokens are valid and have sufficient permissions.
    • Check network connectivity and OmniFlow service status.

Links and References

Discussion