OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

The node integrates with the OmniFlow API to manage contacts and related entities. Specifically, for the Contact - Send Email operation, it sends a campaign email to a specified contact using a selected campaign email template. This is useful in marketing automation workflows where you want to trigger personalized or bulk email campaigns targeted at individual contacts managed within OmniFlow.

Practical examples:

  • Sending a promotional email to a new lead after they are added to your CRM.
  • Triggering a follow-up email campaign to a specific contact based on their activity or status.
  • Automating transactional emails (e.g., welcome emails) using predefined campaign templates.

Properties

Name Meaning
Authentication Method of authentication: either using stored credentials or OAuth2 token.
Campaign Email Name or ID Select or specify the ID of the campaign email template to send.
Contact ID The unique identifier of the contact to whom the email will be sent.

Note: Other properties listed in the JSON relate to other operations or resources and are not relevant for the "Send Email" operation on the "Contact" resource.

Output

The output JSON contains the response from the OmniFlow API after attempting to send the email. It typically includes confirmation details about the email sending action. The exact structure depends on the API response but generally confirms success or failure of the send request.

No binary data output is involved in this operation.

Dependencies

  • Requires an active OmniFlow API connection configured in n8n, authenticated either via credentials or OAuth2.
  • The node uses internal helper functions to make HTTP requests to OmniFlow endpoints.
  • The "Campaign Email Name or ID" property loads options dynamically from the OmniFlow API, so network connectivity and proper API permissions are required.

Troubleshooting

  • Invalid Contact ID or Campaign Email ID: If the IDs provided do not exist or are incorrect, the API call will fail. Verify that the contact and campaign email exist in OmniFlow.
  • Authentication Errors: Ensure the API credentials or OAuth2 tokens are valid and have sufficient permissions to send emails.
  • API Rate Limits or Network Issues: Temporary failures may occur due to rate limiting or connectivity problems. Retrying the workflow might help.
  • Error Messages: The node throws errors if the API returns errors; these include messages like "Invalid JSON" if input JSON parameters are malformed (not applicable here since no JSON input is used for sendEmail), or generic API error messages. Review the error message details for guidance.

Links and References


This summary focuses exclusively on the "Contact" resource and the "Send Email" operation as requested.

Discussion