Instantly icon

Instantly

Interact with Instantly API

Overview

This node interacts with the Instantly API to manage campaigns. Specifically, the "Get" operation for the "Campaign" resource retrieves detailed information about a single campaign by its unique ID.

Common scenarios where this node is useful include:

  • Fetching campaign details to monitor or report on campaign status.
  • Integrating campaign data into workflows for further processing or decision-making.
  • Validating campaign existence before performing updates or deletions.

For example, you might use this node to get the current settings and statistics of a marketing campaign before sending follow-up emails or generating analytics reports.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to retrieve. This is required to specify which campaign's details to fetch.

Output

The output JSON contains the full details of the requested campaign as returned by the Instantly API. This typically includes fields such as campaign name, associated email account ID, creation date, status, and other metadata related to the campaign.

No binary data is output by this node.

Dependencies

  • Requires an active Instantly API key credential configured in n8n to authenticate requests.
  • Depends on the Instantly API being accessible and responsive.
  • Uses a helper function (instantlyApiRequest) to make HTTP requests to the Instantly API endpoints.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will cause the API request to fail.
    • Network connectivity problems can prevent successful API calls.
    • Expired or incorrect API credentials will result in authentication errors.
  • Error messages:

    • Errors from the Instantly API (e.g., "Campaign not found") indicate that the specified Campaign ID does not exist or is inaccessible.
    • Authentication errors suggest checking the API key credential configuration.
    • Rate limiting or server errors from the API may require retrying after some time.

To resolve these issues:

  • Verify the Campaign ID is correct and exists in your Instantly account.
  • Ensure the API key credential is valid and has necessary permissions.
  • Check network connectivity and Instantly service status.

Links and References

Discussion