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 Company, Contact, Deal, Lead, and Ticket. Specifically for the Company resource, the Apply Filter operation allows users to apply predefined filters to a set of company records by their unique IDs. This is useful for segmenting or querying companies based on specific criteria defined in the CRM system.

Practical examples include:

  • Filtering companies that meet certain sales criteria.
  • Applying custom filters to retrieve companies from specific regions or industries.
  • Automating workflows that require processing only filtered subsets of companies.

Properties

Name Meaning
Filter Name or ID Choose a predefined filter from the list or specify its ID via an expression to apply to data.
Company IDs A string containing one or more unique identifiers of companies to which the filter will be applied.

Output

The output is a JSON array containing the filtered company records returned by the BCP CRM API after applying the selected filter. Each item in the array represents a company object matching the filter criteria.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the BCP CRM API.
  • The node makes HTTP requests to the BCP CRM endpoints using the base URL and API key provided in the credentials.
  • Proper configuration of the API key and base URL in the node's credentials is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API key credential will cause authentication failures.
    • Specifying an invalid filter ID or a filter not applicable to the "Company" resource may result in empty or error responses.
    • Providing incorrect or malformed company IDs can lead to no results or errors.
  • Error messages:

    • Errors from the API (e.g., unauthorized, not found) are propagated and can cause the node to fail unless "Continue On Fail" is enabled.
    • If required parameters like "Filter Name or ID" or "Company IDs" are missing, the node will throw validation errors before execution.
  • Resolution:

    • Ensure the API key credential is valid and has sufficient permissions.
    • Verify the filter exists and is applicable to the Company resource.
    • Confirm that company IDs are correct and formatted properly.
    • Use expressions carefully to dynamically provide filter IDs or company IDs.

Links and References

Discussion