OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node interacts with the OmniFlow API to manage contacts and their related data. Specifically, for the Contact resource and the Edit Contact Points operation, it allows you to modify the "points" associated with a contact by either adding or removing them. This can be useful in scenarios where you want to track engagement, loyalty, or any scoring system tied to contacts within your CRM or marketing automation platform.

Practical examples:

  • Increase a contact's points after they complete a purchase or engage with a campaign.
  • Decrease points if a contact unsubscribes or becomes inactive.
  • Automate point adjustments based on user behavior tracked in other systems.

Properties

Name Meaning
Authentication Method of authenticating with the OmniFlow API. Options: Credentials, OAuth2.
Contact ID The unique identifier of the contact whose points you want to edit.
Action Whether to add or remove points from the contact. Options: Add, Remove.
Points The number of points to add or remove from the contact.

Output

The output is a JSON array representing the updated contact information after the points have been edited. The structure typically includes all fields of the contact as returned by the OmniFlow API. If the raw data option is set to false (not shown explicitly here but available in other operations), only the core fields are returned without additional metadata.

No binary data output is involved in this operation.

Dependencies

  • Requires an active OmniFlow API connection authenticated via either:
    • An API key credential
    • OAuth2 authentication token
  • The node depends on the omniflowApiRequest helper function to make HTTP requests to the OmniFlow API.
  • Proper configuration of credentials in n8n is necessary before using this node.

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 is correct.
  • Insufficient Permissions: Using incorrect or expired credentials may cause authorization errors. Ensure the API key or OAuth2 token is valid and has permissions to edit contacts.
  • Points Value Issues: Providing a non-numeric or negative value for points (when adding) might cause unexpected behavior or errors. Always provide a positive integer for points.
  • API Errors: If the OmniFlow API returns errors, these are thrown as node errors. Check the error message for details and verify the request parameters.
  • Continue On Fail: If enabled, the node will continue processing subsequent items even if one fails, returning error details in the output JSON.

Links and References

Discussion