Instantly icon

Instantly

Interact with Instantly API

Actions15

Overview

This node interacts with the Instantly API to retrieve information about campaigns, leads, accounts, and analytics. Specifically, for the Campaign - Get operation, it fetches details of a single campaign by its ID or from a selectable list. This is useful when you want to obtain detailed data about a specific marketing campaign managed in Instantly, such as its configuration or status.

Practical examples:

  • Fetching campaign details to display or process within an automation workflow.
  • Using campaign data to trigger further actions like sending emails or updating CRM records.
  • Integrating campaign info into reports or dashboards.

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 details retrieved from the Instantly API. The structure corresponds to the campaign object returned by the API endpoint /api/v2/campaigns/{campaignId}.

The output is an array of JSON objects, each containing fields describing the campaign's properties (e.g., name, id, status). There is no binary data output for this operation.

Dependencies

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

Troubleshooting

  • Invalid Campaign ID: If the specified campaign ID does not exist or is malformed, the API will return an error. Verify the ID format or select a campaign from the list to avoid typos.
  • API Rate Limits: Excessive requests may be throttled by the Instantly API. Implement retry logic or reduce request frequency.
  • Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to access campaign data.
  • Empty Results: If no campaign is found, check that the campaign exists and that the user account has access rights.

Common error messages:

  • "Limit cannot exceed 100": This applies to other operations but indicates the maximum number of items retrievable per request.
  • Network or timeout errors: Check connectivity and API availability.

Links and References

Discussion