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 allows updating lead information in a Lead Management system via an API. It is designed to modify existing lead records by specifying the lead through various search methods (Lead ID, Vendor Lead Code, or Phone Number) and updating fields such as contact details, status, and custom attributes.
Common scenarios include:
- Synchronizing lead data from external sources.
- Correcting or enriching lead information after initial capture.
- Managing lead lifecycle states programmatically.
For example, a sales automation workflow could use this node to update a lead’s phone number and status after a call or form submission.
Properties
| Name | Meaning |
|---|---|
| Function | API function name; fixed to "Update Lead" for this operation. |
| User | API user credential for authentication. |
| Pass | API password credential for authentication. |
| Source | Description of what originated the API call; default is "n8n". |
| Lead Id | Unique identifier of the lead to update. |
| Vendor Lead Code | Alternative lead identifier provided by vendor. |
| Phone Number | Phone number associated with the lead (6-16 digits). |
| Search Method | Method to locate the lead: LEAD_ID, VENDOR_LEAD_CODE, or PHONE_NUMBER. |
| Search Location | Where to search for the lead: LIST, CAMPAIGN, SYSTEM, CURRENT, ARCHIVE, or ALL. |
| Records | Additional record identifiers or parameters (usage depends on API specifics). |
| Custom Fields | Whether to include custom fields in the update ("Y" or "N"). |
| No Update | Flag to prevent update if set to "Y"; otherwise "N". |
| Delete Lead | Flag to delete the lead instead of updating ("Y" or "N"). |
| Reset Lead | Flag to reset lead data ("Y" or "N"). |
| First Name | Lead's first name. |
| Last Name | Lead's last name. |
| Address 1 | Lead's primary address line. |
| City | Lead's city. |
| State | Lead's state or region. |
| Status | Lead's current status. |
| User Field | Custom user-defined field. |
| List Id Field | Identifier for the list the lead belongs to. |
| Callback | Callback flag with options "Y", "N", or "REMOVE". |
| Add To Hopper | Flag to add the lead to hopper queue ("Y" or "N"). |
| Remove From Hopper | Flag to remove the lead from hopper queue ("Y" or "N"). |
Output
The node outputs JSON data representing the response from the Lead Management API after attempting to update the lead. This typically includes confirmation of the update, any error messages, or the updated lead data.
No binary data output is indicated.
Dependencies
- Requires an API key credential (user and password) for authenticating with the Lead Management system.
- The node sends requests to the configured API endpoint using query parameters based on the input properties.
- Proper configuration of credentials and API host URL in n8n is necessary.
Troubleshooting
- Authentication errors: Ensure that valid API user and password credentials are provided.
- Lead not found: If the lead cannot be located using the specified search method and location, verify the identifiers and search parameters.
- Invalid input values: Fields like phone number must meet format requirements (6-16 digits).
- API errors: Check the API response for specific error messages; these may indicate permission issues, invalid parameters, or server problems.
- No update performed: If the "No Update" flag is set to "Y", the lead will not be modified even if found.
Links and References
- Refer to the Lead Management system’s API documentation for detailed parameter descriptions and response formats.
- n8n documentation on creating and configuring API nodes for further customization.