Instantly icon

Instantly

Interact with Instantly API

Actions15

Overview

This node interacts with the Instantly API to manage campaigns, accounts, and leads. Specifically for the Campaign - Get Many operation, it retrieves multiple campaign records from the Instantly platform. This is useful when you want to fetch a list of campaigns for reporting, analysis, or further processing in your workflow.

Typical use cases include:

  • Retrieving all campaigns to display or process them in bulk.
  • Fetching a limited number of campaigns to avoid large data loads.
  • Integrating campaign data into dashboards or CRMs.

For example, you might use this node to get all campaigns associated with your Instantly account and then filter or analyze them downstream in your automation.

Properties

Name Meaning
Return All Whether to return all campaign results or only up to a specified limit.
Limit The maximum number of campaign results to return (only applicable if "Return All" is false).

Output

The output is a JSON array where each item represents a campaign object as returned by the Instantly API. Each campaign object typically includes details such as campaign ID, name, associated email account ID, and other metadata related to the campaign.

No binary data is output by this operation.

Example output structure (simplified):

[
  {
    "id": "campaign_123",
    "name": "My Campaign",
    "emailAccountId": "email_account_456",
    ...
  },
  {
    "id": "campaign_789",
    "name": "Another Campaign",
    "emailAccountId": "email_account_456",
    ...
  }
]

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node uses the Instantly API endpoints under /api/v2/campaigns.
  • No additional environment variables are required beyond the API authentication setup.

Troubleshooting

  • Common issues:

    • Authentication errors due to invalid or missing API credentials.
    • Request limits exceeded if too many campaigns are requested without pagination.
    • Network connectivity problems affecting API calls.

  • Error messages:

    • Errors returned from the Instantly API will be passed through. For example, "Unauthorized" indicates invalid credentials.
    • If the node is set to continue on fail, errors will appear in the output JSON under an error field.

  • Resolutions:

    • Verify that the API key credential is correctly configured and has necessary permissions.
    • Use the "Limit" property to restrict the number of campaigns fetched if performance issues occur.
    • Check network connectivity and proxy settings if requests fail.

Links and References

Discussion