Instantly icon

Instantly

Interact with Instantly API

Overview

This node integrates with the Instantly API to add a lead to a specified campaign. It is useful in marketing automation workflows where you want to programmatically enroll leads into email or marketing campaigns based on triggers or data from other systems.

Typical use cases include:

  • Automatically adding new contacts collected from forms or CRM systems into targeted campaigns.
  • Personalizing campaign messages by including custom fields and personalized text for each lead.
  • Managing lead lists dynamically without manual intervention.

For example, when a new user signs up on your website, this node can add their contact details to a specific email campaign, optionally customizing the message with personalization tokens and custom fields.

Properties

Name Meaning
Campaign The campaign to which the lead will be added. Can be selected from a list of existing campaigns or specified by ID.
Email The email address of the lead to add.
First Name The first name of the lead.
Last Name The last name of the lead.
Personalization A custom message or personalization string to tailor the campaign messaging for this lead.
Custom Fields Key-value pairs representing additional custom data fields for campaign personalization. Each field has a name and a value.

Output

The node outputs JSON data representing the result of the operation for each input item. This typically includes confirmation that the lead was successfully added to the campaign or error information if the operation failed.

The output JSON structure corresponds to the response from the Instantly API after attempting to add the lead to the campaign. It may include identifiers, status messages, or error details.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • Needs network access to Instantly's REST API endpoints.
  • Uses internal helper functions to make HTTP requests to Instantly's API.
  • The node depends on n8n's resource locator UI components to select campaigns either from a searchable list or by direct ID input.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying a non-existent campaign ID or email address may result in errors from the API.
    • Network connectivity problems can prevent communication with the Instantly API.
    • Missing required fields (email, first name, last name) will cause validation errors.
  • Error messages:

    • Errors returned from the Instantly API are passed through in the output JSON under an error property.
    • If the node is configured to continue on failure, errors for individual items will be included in the output rather than stopping execution.
    • Typical error resolution involves verifying API credentials, ensuring the campaign exists, and validating input data formats.

Links and References

Discussion