OmniFlow icon

OmniFlow

Consume OmniFlow API

Actions20

Overview

This node integrates with the OmniFlow API to manage contacts and related entities. Specifically, for the Contact - Delete operation, it deletes a contact identified by a given Contact ID from the OmniFlow system.

Common scenarios where this node is useful include:

  • Automating cleanup of outdated or invalid contacts in your CRM.
  • Removing contacts as part of a data compliance or GDPR workflow.
  • Integrating contact deletion into broader automation workflows that manage customer lifecycle.

Example: Automatically delete a contact when they unsubscribe or request removal from your marketing database.

Properties

Name Meaning
Authentication Method of authentication to use: either "Credentials" (API key) or "OAuth2" token.
Contact ID The unique identifier of the contact to delete.
Options Additional options for the operation (not used specifically for delete but available).

The Options property includes fields mostly relevant for other operations like getAll, but for delete, only the RAW Data boolean option is relevant:

  • RAW Data: If true (default), returns the full raw response from the API including all metadata; if false, returns only the main data fields of the deleted contact.

Output

The output JSON contains information about the deleted contact returned from the OmniFlow API. It is an array with one element representing the deleted contact's data.

  • If RAW Data is set to false, the output will be simplified to only the core fields of the contact.
  • If RAW Data is true, the output includes the full raw response from the API.

No binary data is involved in this operation.

Example output structure (simplified):

[
  {
    "id": "contact-id",
    "fields": {
      "all": {
        "firstname": "John",
        "lastname": "Doe",
        "email": "[email protected]"
        // ... other contact fields
      }
    }
  }
]

Dependencies

  • Requires an active OmniFlow API credential configured in n8n, either via API key credentials or OAuth2 authentication.
  • The node uses internal helper functions to make HTTP requests to the OmniFlow REST API endpoints.
  • No additional external dependencies beyond the OmniFlow API access.

Troubleshooting

  • Invalid Contact ID: If the provided Contact ID does not exist or is malformed, the API will return an error. Ensure the Contact ID is correct.
  • Authentication Errors: If the API credentials are missing, expired, or incorrect, the node will fail with an authentication error. Verify your API key or OAuth2 token.
  • API Rate Limits: Frequent deletions may hit API rate limits imposed by OmniFlow. Consider adding delays or handling errors gracefully.
  • Raw Data Option Confusion: Setting RAW Data to false simplifies output but may omit some metadata. Set to true if you need full details.

Common error message example:

  • "error": "Contact not found" — means the Contact ID does not exist.
  • "error": "Unauthorized" — indicates authentication failure.

To resolve errors, verify input parameters and credentials, and consult OmniFlow API documentation for endpoint-specific requirements.

Links and References

Discussion