Instantly icon

Instantly

Interact with Instantly API

Overview

This node integrates with the Instantly API to perform operations on marketing campaigns, leads, accounts, and analytics data. Specifically, for the Campaign - Get operation, it retrieves detailed information about a single campaign identified by its ID or selected from a list.

Use cases include:

  • Fetching campaign details to monitor or update campaign settings.
  • Integrating campaign data into workflows for reporting or automation.
  • Triggering subsequent actions based on campaign status or metrics.

For example, you might use this node to get the current configuration of a campaign before launching it or to retrieve campaign metadata for syncing with another system.

Properties

Name Meaning
Campaign The campaign to operate on. You can select a campaign from a searchable list or specify its unique ID directly.

The "Campaign" property supports two modes:

  • From List: Select a campaign from a dropdown populated by fetching available campaigns via the API.
  • By ID: Manually enter the campaign's unique identifier.

Output

The node outputs JSON data representing the campaign object retrieved from the Instantly API. This typically includes all relevant campaign fields such as name, ID, status, settings, and other metadata provided by the API.

The output is structured as an array of JSON objects (one per input item), each containing the campaign details under the json key.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node depends on the Instantly API endpoints, specifically /api/v2/campaigns.
  • Network connectivity to Instantly's API service is necessary.
  • No additional environment variables are required beyond the API authentication setup in n8n.

Troubleshooting

  • Common issues:

    • Invalid or missing campaign ID: Ensure the campaign ID is correct or that a valid campaign is selected from the list.
    • API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
    • Network or API downtime: Check network connectivity and Instantly API status if requests fail.
  • Error messages:

    • "Failed to load campaigns" or similar errors when populating the campaign dropdown indicate issues fetching campaigns; check API credentials and connectivity.
    • Errors returned during execution will be included in the output JSON under an error field if "Continue On Fail" is enabled.

Links and References

Discussion