VICIdial icon

VICIdial

Interact with VICIdial Non-Agent API

Actions58

Overview

This node integrates with the VICIdial Non-Agent API to perform batch updates on leads within a lead management system. It is designed to update multiple lead records simultaneously by specifying their IDs and desired changes, such as status or user assignment. This functionality is useful in scenarios where bulk modifications are needed, for example, updating the status of several leads after a marketing campaign or reassigning leads to different users based on workload.

Practical examples include:

  • Changing the status of multiple leads from "New" to "Contacted".
  • Assigning a group of leads to a specific sales representative.
  • Resetting lead information in bulk after data cleanup.

Properties

Name Meaning
Function The API function to call; fixed to "Batch Update Lead" for this operation.
User API user credential used for authentication.
Pass API password credential used for authentication.
Source Description of what originated the API call; defaults to "n8n".
Lead Ids Comma-separated list of lead IDs to be updated.
Status New status value to assign to the leads.
User Field Identifier for the user field to update (e.g., user assigned to the lead).
List Id Field Identifier for the list ID field to update.
Reset Lead Option to reset the lead ("Y" for yes, "N" for no).
Records Additional record data to send with the update request.

Output

The node outputs JSON data representing the response from the VICIdial API after attempting the batch update. This typically includes confirmation of the update status for each lead or error messages if any issues occurred. The output does not handle binary data.

Dependencies

  • Requires an API key credential with appropriate permissions to access the VICIdial Non-Agent API.
  • Needs configuration of the API host URL in the node credentials.
  • The node sends requests to the /vicidial endpoint of the configured host.

Troubleshooting

  • Invalid Credentials: If authentication fails, verify that the API user and password are correct and have sufficient permissions.
  • Incorrect Lead IDs: Ensure that the Lead Ids property contains valid, comma-separated lead identifiers.
  • API Errors: The API may return errors if required fields are missing or invalid. Check the response message for details.
  • Network Issues: Confirm that the host URL is reachable and there are no firewall restrictions blocking the request.
  • Reset Lead Option: Using the reset option incorrectly might cause unintended data loss; use with caution.

Links and References

Discussion