VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Overview

This node interacts with a Lead Management API to retrieve detailed information about specific lead fields. It is designed to fetch metadata or values related to a particular field of a lead, which can be useful for dynamically understanding lead data structure or validating lead information in workflows.

Common scenarios include:

  • Fetching the current value or metadata of a lead's custom or standard field before performing updates.
  • Validating lead data by checking field details during automation.
  • Integrating lead data insights into CRM or marketing automation pipelines.

For example, you might use this node to get the value of a "status" field for a lead with a given ID, or to check if a custom field exists and what its current value is.

Properties

Name Meaning
Function API function name; fixed to "Lead Field Info" for this operation.
User API user credential string used for authentication.
Pass API password credential string used for authentication.
Source Description of what originated the API call; default is "n8n".
Lead Id The unique identifier of the lead whose field info is being requested.
Field Name The name of the lead field to retrieve information about.
Custom Fields Whether to include custom fields in the query; options are "Y" (yes) or "N" (no).
List Id Identifier of the list associated with the lead, if applicable.
Archived Lead Whether to include archived leads in the query; options are "Y" (yes) or "N" (no).

Output

The node outputs JSON data containing the response from the Lead Management API for the specified lead field. This typically includes the field's current value, metadata, or status as returned by the API.

No binary data output is indicated or expected.

Dependencies

  • Requires an API key credential consisting of a user and password for authenticating with the Lead Management API.
  • The node sends HTTP requests to the configured API endpoint using these credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Authentication errors: If the API user or password is incorrect or missing, the node will fail to authenticate. Verify credentials are correctly set.
  • Invalid Lead Id or Field Name: Providing a non-existent lead ID or field name may result in empty or error responses. Confirm that IDs and field names are valid.
  • Network issues: Connectivity problems to the API endpoint can cause request failures. Check network access and API availability.
  • Incorrect option values: For boolean options like "Custom Fields" and "Archived Lead," ensure only "Y" or "N" are used.

Links and References

  • Refer to your Lead Management API documentation for detailed descriptions of the "lead_field_info" function and expected parameters.
  • n8n documentation on creating and configuring HTTP request nodes may provide additional context on how this node operates internally.

Discussion