Perfex CRM icon

Perfex CRM

Consumir API do Perfex CRM
Join our community

Actions5

Overview

This node integrates with the Perfex CRM API to manage leads. It supports operations such as creating, retrieving, updating, deleting, searching, and listing leads within the CRM system. This node is useful for automating lead management workflows, syncing lead data between systems, or enriching lead information in real-time.

Practical examples:

  • Automatically fetch a lead's details by ID when triggered by an event.
  • Create new leads in Perfex CRM from form submissions or other sources.
  • Update lead information based on external data changes.
  • Search for leads matching specific criteria.
  • Delete leads that are no longer relevant.

Properties

Name Meaning
ID do Lead The unique identifier of the lead to retrieve, update, or delete.

The node also supports other properties for different operations (not requested here), including:

  • Required fields for creating or updating a lead: source, status, name, assigned (responsible person).
  • Optional fields for creating or updating a lead: client ID, tags, contact, title, email, website, phone number, company, address, city, zip code, state, country, default language, description, custom contact date, contacted today flag, public flag, last contact date.
  • Search term for searching leads.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains the response data from the Perfex CRM API for the requested operation.

For the "Obter" (get) operation on a lead, the output JSON will contain the detailed information of the specified lead as returned by the API.

If an error occurs and "Continue On Fail" is enabled, the output will include an object with an error field describing the issue.

The node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Perfex CRM API.
  • The base URL of the Perfex CRM instance must be configured in the credentials.
  • Uses HTTP requests via Axios library to communicate with the API.

Troubleshooting

  • Common issues:

    • Invalid or missing lead ID when performing get, update, or delete operations.
    • Incorrect API URL or authentication token leading to authorization errors.
    • Network connectivity problems preventing API calls.
    • Missing required fields when creating or updating leads.

  • Error messages:

    • Errors thrown by the API (e.g., 404 Not Found if lead ID does not exist).
    • Authentication failures due to invalid API key.
    • Validation errors if required fields are missing or invalid.

  • Resolutions:

    • Verify the lead ID is correct and exists in the CRM.
    • Check that the API key and URL are correctly set in the node credentials.
    • Ensure all required fields are provided for create/update operations.
    • Enable "Continue On Fail" to handle errors gracefully in workflows.

Links and References

Discussion