OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node allows updating an existing contact in the OmniFlow system via its API. It is useful for workflows that need to modify contact details such as name, email, address, social media profiles, tags, and custom fields dynamically based on external triggers or data changes.

Typical use cases include:

  • Synchronizing updated customer information from other systems into OmniFlow.
  • Enriching contact records with additional data collected from forms or other sources.
  • Automating updates to contact segmentation or status fields based on business logic.

For example, you could update a contact’s phone number and add new tags after a customer support interaction, or change their stage and owner assignment when they move through a sales pipeline.

Properties

Name Meaning
Authentication Method of authentication to use: either "Credentials" (API key) or "OAuth2".
Contact ID The unique identifier of the contact to update.
JSON Parameters Whether to provide update parameters as raw JSON instead of individual fields.
Update Fields Collection of fields to update on the contact. Includes:
- Body (JSON) Raw JSON string representing contact parameters (used if JSON Parameters is true).
- Address Contact's address details: Address Line 1, Address Line 2, City, State, Country, Zip Code.
- B2B or B2C Specify if the contact is Business-to-Business (B2B) or Business-to-Consumer (B2C). Options: "B2B", "B2C".
- CRM ID CRM system identifier for the contact.
- Custom Fields Custom fields to set on the contact, allowing setting values not predefined by default. Each custom field requires a field name/ID and a value.
- Email Contact's email address.
- Fax Contact's fax number.
- First Name Contact's first name.
- Has Purchased Boolean indicating if the contact has made a purchase.
- IP Address IP address associated with the contact.
- Last Active Date/time of last activity in UTC.
- Last Name Contact's last name.
- Mobile Contact's mobile phone number.
- Owner ID ID of the user to assign ownership of this contact.
- Phone Contact's phone number.
- Position Contact's job position.
- Primary Company Company name or ID associated with the contact.
- Prospect or Customer Whether the contact is a "Prospect" or "Customer".
- Sandbox Boolean flag indicating sandbox mode.
- Stage Name or ID Sales or lifecycle stage name or ID.
- Tag Names or IDs List of tag names or IDs to associate with the contact.
- Title Contact's title.
- Social Media Social media profiles including Facebook, Foursquare, Instagram, LinkedIn, Skype, Twitter.
- Website Contact's website URL.

Output

The node outputs an array of JSON objects representing the updated contact(s). By default, it returns only the core data fields of the contact (fields.all). If the option RAW Data is enabled, the full raw response from the API is returned, which includes all metadata and nested properties.

No binary data output is produced by this operation.

Dependencies

  • Requires an active OmniFlow API connection configured in n8n, either via API key credentials or OAuth2 authentication.
  • The node uses the OmniFlow REST API endpoints to perform updates on contacts.
  • Proper permissions on the OmniFlow account are necessary to update contact records.

Troubleshooting

  • Invalid JSON Error: When using the JSON Parameters option, if the provided JSON string is malformed or invalid, the node will throw an error "Invalid JSON". Ensure the JSON syntax is correct before running.
  • Contact Not Found: If the specified Contact ID does not exist, the API may return an error. Verify the Contact ID is correct and exists in OmniFlow.
  • Permission Denied: Insufficient API permissions or incorrect authentication setup can cause authorization errors. Check your API credentials and scopes.
  • Field Validation Errors: Some fields may require specific formats or valid values (e.g., dates in UTC, valid email format). Invalid inputs may cause the API to reject the update.
  • Continue On Fail: If enabled, the node will continue processing remaining items even if one fails, returning error messages in the output JSON.

Links and References

Discussion