Instantly icon

Instantly

Interact with Instantly API

Overview

This node integrates with the Instantly API to manage marketing campaigns and related resources. Specifically, the "Pause" operation on the "Campaign" resource allows users to pause an active campaign. This is useful in scenarios where a campaign needs to be temporarily halted without deleting or permanently stopping it, such as during budget adjustments, performance reviews, or compliance checks.

Practical examples:

  • Temporarily pausing a campaign that is underperforming to analyze metrics before resuming.
  • Pausing a campaign due to external events or holidays.
  • Managing multiple campaigns programmatically by pausing and resuming based on business logic.

Properties

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

The "Campaign" property supports two modes for specifying the campaign:

  • From List: Select a campaign from a dropdown list populated dynamically via the Instantly API.
  • By ID: Enter the unique identifier of the campaign manually.

Output

The node outputs JSON data representing the result of the requested operation. For the "Pause" operation on a campaign, the output typically includes details about the paused campaign or confirmation of the action.

If an error occurs during execution, the output JSON will contain an error field with the error message.

No binary data output is indicated in the source code.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node uses the Instantly API endpoints to fetch campaigns and perform operations.
  • No additional environment variables are explicitly required beyond the API authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing campaign ID: Ensure the campaign exists and the ID is correct.
    • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
    • Network or API downtime: Check connectivity and Instantly API status.
  • Error messages:

    • Errors thrown by the Instantly API (e.g., "campaign not found") will be returned in the output JSON's error field if "Continue On Fail" is enabled.
    • If the node fails to load campaigns for the dropdown, it logs an error but returns an empty list, so no campaigns appear in the selector.

Links and References

Discussion