Actions58
- Lead Management Actions
- User Agent Management Actions
- Campaign Management Actions
- Phone DID Management Actions
- List Management Actions
- Reporting Monitoring Actions
- System Info Actions
- Other Operations Actions
Overview
This node interacts with the VICIdial Non-Agent API to perform lead management operations. Specifically, the "Lead Dearchive" operation allows users to restore a previously archived lead back into active status within the VICIdial system. This is useful in scenarios where leads were archived but later need to be reactivated for follow-up or further processing.
Practical examples include:
- Reactivating a lead that was mistakenly archived.
- Restoring leads for renewed marketing campaigns.
- Managing lead lifecycle by toggling archive status programmatically.
Properties
| Name | Meaning |
|---|---|
| Function | The API function to call; here it is fixed as "Lead Dearchive". |
| User | The API user credential used for authentication with the VICIdial API. |
| Pass | The API password credential used for authentication with the VICIdial API. |
| Source | A description of what originated the API call; defaults to "n8n". |
| Lead Id | The unique identifier of the lead to be dearchived (restored from archive). |
Output
The node outputs JSON data representing the response from the VICIdial API after attempting to dearchive the specified lead. The exact structure depends on the API response but typically includes confirmation of success or failure and any relevant metadata about the lead's new status.
No binary data output is involved in this operation.
Dependencies
- Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
- The node uses the base URL configured in the credentials to send requests to the VICIdial server.
- No additional external services are required beyond access to the VICIdial API endpoint.
Troubleshooting
- Authentication errors: Ensure the provided user and password credentials are correct and have sufficient permissions.
- Invalid Lead ID: If the lead ID does not exist or is already active, the API may return an error or no effect.
- Network issues: Verify connectivity to the VICIdial server and that the base URL is correctly configured.
- API function mismatch: The function property is auto-filled and should not be changed; altering it may cause unexpected errors.
Common error messages will generally come from the VICIdial API and relate to authentication failures, invalid parameters, or server errors. Checking credentials and input values usually resolves these issues.
Links and References
- VICIdial Official Documentation
- VICIdial API Reference (community resource)
- n8n documentation on HTTP Request Node for understanding API calls in workflows