Instantly icon

Instantly

Interact with Instantly API

Actions24

Overview

This node interacts with the Instantly API to retrieve multiple lead records based on specified filters and limits. It is useful for scenarios where you want to fetch a list of leads from your marketing or sales campaigns, optionally filtered by criteria such as contact status, campaign membership, or email service provider (ESP). For example, you might use this node to get all leads that have been contacted but not yet closed, or to retrieve leads associated with a specific campaign for further processing or analysis.

Properties

Name Meaning
Return All Whether to return all matching lead results or only up to a specified limit.
Limit The maximum number of lead results to return when "Return All" is false. Must be between 1 and 100.
Filters A collection of filter options to narrow down the leads returned:
- Search Text search applied to first name, last name, or email of leads.
- Filter Predefined filter criteria for leads, including: All, Contacted, Not Contacted, Completed, Unsubscribed, Active, Interested, Not Interested, Meeting Booked, Meeting Completed, Closed.
- Campaign Filter leads by a specific campaign, selectable either from a list of campaigns or by entering a campaign ID.
- In Campaign Boolean indicating whether to include only leads that are in the specified campaign (true) or not (false).
- ESP Code Filter leads by their Email Service Provider code. Options include All, In Queue, Google, Microsoft, Zoho, Yahoo, Yandex, Web.de, Libero.it, Other, Not Found.

Output

The node outputs an array of JSON objects representing the leads retrieved from the Instantly API. Each object contains lead details such as first name, last name, email, and other relevant metadata as provided by the API. The output does not include binary data.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node depends on the Instantly API endpoints to fetch lead data.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:
    • Invalid or missing API credentials will cause authentication failures.
    • Providing an invalid campaign ID format will result in validation errors.
    • Requesting more than 100 leads without enabling "Return All" may cause unexpected truncation.
  • Error Messages:
    • Errors related to fetching campaigns or leads for dropdowns will log messages like "Error fetching campaigns for dropdown".
    • API request failures typically throw errors with descriptive messages; ensure network connectivity and valid credentials.
  • Resolutions:
    • Verify API key validity and permissions.
    • Ensure campaign IDs match the UUID regex pattern.
    • Use "Return All" carefully to avoid large data loads impacting performance.

Links and References

Discussion