OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage company data within workflows. Specifically, the "Company - Create" operation allows users to create a new company record in OmniFlow by providing essential details such as the company name and optional additional information like address, industry, contact details, and custom fields.

Common scenarios for this node include:

  • Automating the creation of company records when new leads or accounts are generated in other systems.
  • Enriching CRM data by programmatically adding companies with detailed attributes.
  • Integrating OmniFlow with other business tools to maintain up-to-date company information without manual entry.

For example, a marketing automation workflow could use this node to add newly qualified leads as companies in OmniFlow, including their address and industry, enabling targeted campaigns.

Properties

Name Meaning
Authentication Method of authentication to use: either "Credentials" (API key) or "OAuth2".
Company Name The name of the company to create. This is a required string input.
Simplify Boolean flag indicating whether to return a simplified version of the response (only the main fields) or the full raw data from the API.
Additional Fields A collection of optional fields to provide more company details:
- Address Structured address fields including Address Line 1, Address Line 2, City, State, Country, and Zip Code.
- Annual Revenue Numeric value representing the company's annual revenue.
- Company Email Email address associated with the company.
- Custom Fields Allows setting custom fields by specifying field names or IDs and their corresponding values. Useful for fields not predefined in the node.
- Description Text description of the company.
- Fax Fax number of the company.
- Industry Name or ID Industry classification chosen from a list or specified by ID.
- Is Published Boolean indicating if the company record should be marked as published.
- Number of Employees Numeric count of employees in the company.
- Overwrite With Blank Boolean that determines whether empty values should overwrite existing fields (true) or be skipped (false).
- Phone Phone number of the company.
- Website Website URL of the company.

Output

The output JSON contains the created company data returned from the OmniFlow API. Depending on the "Simplify" property:

  • If simplify is true, the output includes a simplified object containing only the main fields of the company.
  • If false, the output returns the full raw response from the API, which may include nested fields and metadata.

The output structure typically looks like this (simplified form):

{
  "companyname": "Example Company",
  "companyaddress1": "123 Main St",
  "companycity": "Anytown",
  "companyindustry": "Technology",
  "companyemail": "[email protected]",
  ...
}

No binary data is produced by this node.

Dependencies

  • Requires an active OmniFlow API connection, authenticated either via API credentials or OAuth2.
  • The node depends on the OmniFlow API endpoints for creating companies (POST /companies/new).
  • No additional environment variables or external services beyond OmniFlow API access are needed.

Troubleshooting

  • Invalid JSON in Custom Fields: If custom fields are provided with invalid JSON syntax, the node will throw an error. Ensure all JSON inputs are correctly formatted.
  • API Errors: If the OmniFlow API returns errors (e.g., due to missing required fields or invalid data), the node will throw an error with the message from the API. Verify all required properties are set and valid.
  • Authentication Failures: Incorrect or expired credentials will cause authentication errors. Confirm that the API key or OAuth2 token is valid and has necessary permissions.
  • Empty Required Fields: Omitting the company name or other mandatory fields will result in failure. Always provide required inputs.
  • Overwrite With Blank: Setting this to false means empty fields won't update existing data; if you expect fields to clear out, enable this option.

Links and References

Discussion