OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage contacts within the OmniFlow system. Specifically, the Contact - Create operation allows users to create new contact records by providing various details such as email, name, company affiliation, position, and other optional fields.

Common scenarios where this node is beneficial include:

  • Automating the addition of new leads or customers into OmniFlow from external sources.
  • Synchronizing contact data from other systems or forms into OmniFlow.
  • Enriching contact records with detailed information like social media profiles, tags, and custom fields.

For example, a marketing automation workflow could use this node to add new webinar registrants as contacts in OmniFlow, including their company info, job title, and social media links.

Properties

Name Meaning
Authentication Method of authentication to use: either "Credentials" (API key) or "OAuth2".
JSON Parameters Whether to provide contact parameters as raw JSON instead of individual fields.
Email Email address of the contact.
First Name Contact's first name.
Last Name Contact's last name.
Primary Company Name or ID The primary company associated with the contact. Can be selected from a list or specified via an expression.
Position Job position of the contact.
Title Contact's title.
Body (JSON) Raw JSON object containing contact parameters when JSON Parameters is enabled.
Additional Fields Collection of optional fields to enrich the contact record, including:
- Address Contact's address details (line 1, line 2, city, state, country, zip code).
- B2B or B2C Indicates if the contact is business-to-business (B2B) or business-to-consumer (B2C). Options: "B2B", "B2C".
- CRM ID Custom CRM identifier for the contact.
- Custom Fields Allows setting additional custom fields by specifying field IDs and values.
- Fax Fax number of the contact.
- Has Purchased Boolean indicating if the contact has made a purchase.
- IP Address IP address associated with the contact.
- Last Active Date/time (UTC) representing the last activity of the contact.
- Mobile Mobile phone number.
- Owner ID ID of a user to assign ownership of the contact.
- Phone Phone number.
- Prospect or Customer Indicates whether the contact is a prospect or a customer. Options: "Prospect", "Customer".
- Sandbox Boolean flag to mark the contact as a sandbox/test entry.
- Stage Name or ID Sales or lifecycle stage of the contact. Can be selected from a list or specified via an expression.
- Tag Names or IDs Tags associated with the contact. Multiple tags can be selected or specified via expressions.
- Social Media Social media profile URLs or usernames for Facebook, Foursquare, Instagram, LinkedIn, Skype, Twitter.
- Website Contact's website URL.
Options Additional options related to the contact creation operation, including a "RAW Data" boolean to control response format.

Output

The output is a JSON array where each item corresponds to a created contact. Each item contains:

  • A json object representing the contact data returned by the OmniFlow API.
  • By default, the node returns only the core fields of the contact (fields.all).
  • If the "RAW Data" option is set to true, the full raw API response for the contact is returned, including all metadata and nested fields.

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.
  • Uses internal helper functions to make HTTP requests to OmniFlow endpoints.
  • Some properties load dynamic options from OmniFlow, such as companies, tags, stages, and contact fields.

Troubleshooting

  • Invalid JSON error: When using the "JSON Parameters" option, the provided JSON must be valid. Invalid JSON will cause an error. Validate JSON syntax before running.
  • Authentication errors: Ensure that the API key or OAuth2 credentials are correctly configured and have sufficient permissions.
  • Missing required fields: At minimum, the contact's email should be provided; otherwise, the API may reject the request.
  • API rate limits or network issues: These can cause request failures. Check network connectivity and OmniFlow API status.
  • Field validation errors: Custom fields or options must match expected formats and existing field IDs; otherwise, the API may return errors.

Links and References

Discussion