BCP CRM icon

BCP CRM

Interact with BCP CRM API

Overview

This node integrates with the BCP CRM API to perform various operations on CRM resources such as Leads, Contacts, Companies, Deals, and Tickets. Specifically, for the Lead resource with the Get By Filter operation, it retrieves a list of leads filtered by a predefined filter ID or name.

Common scenarios where this node is beneficial include:

  • Automating lead retrieval based on specific criteria defined in saved filters.
  • Integrating filtered lead data into workflows for further processing, such as sending follow-up emails or updating other systems.
  • Dynamically loading leads that meet certain conditions without manually querying the CRM each time.

For example, you might use this node to fetch all leads that have been marked as "Hot" in your CRM filter settings and then pass them downstream for targeted marketing campaigns.

Properties

Name Meaning
Filter Name or ID Select a predefined filter from the list or specify its ID via an expression to filter the leads.

The property Filter Name or ID allows choosing from available filters loaded dynamically from the CRM or specifying a filter ID directly using expressions.

Output

The node outputs an array of JSON objects representing the leads that match the selected filter. Each object contains the lead's data fields as returned by the BCP CRM API.

  • The output field json holds the lead records.
  • If multiple leads are returned, they are output as an array of JSON objects.
  • No binary data output is produced by this operation.

Example output structure (simplified):

[
  {
    "id": "lead_123",
    "name": "John Doe",
    "email": "john.doe@example.com",
    "status": "New",
    ...
  },
  {
    "id": "lead_456",
    "name": "Jane Smith",
    "email": "jane.smith@example.com",
    "status": "Contacted",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the BCP CRM API.
  • The node makes HTTP requests to the BCP CRM endpoints, so network access to the CRM API base URL is necessary.
  • The filter options are dynamically loaded from the CRM, so the user must have appropriate permissions to access filters and lead data.

Troubleshooting

  • Common issues:

    • Using an invalid or expired API key will cause authentication failures.
    • Specifying a filter ID that does not exist or is not accessible will result in no data or errors.
    • Network connectivity problems can prevent successful API calls.
  • Error messages:

    • "The 'Last Name' field is required for creating" — occurs if trying to create a lead without a last name (not relevant for Get By Filter but part of node logic).
    • API response errors indicating permission denied or invalid filter ID.
  • Resolutions:

    • Verify the API key and ensure it has sufficient permissions.
    • Confirm the filter exists and is accessible by the authenticated user.
    • Check network connectivity and firewall settings.

Links and References

Discussion