Instantly icon

Instantly

Interact with Instantly API

Overview

This node allows users to create a new email campaign in the Instantly platform via its API. It is designed for marketing automation scenarios where businesses want to schedule and manage email outreach campaigns targeting leads or contacts. The node supports detailed scheduling options, email sequence steps, and various campaign settings to control how and when emails are sent.

Practical examples include:

  • Setting up a drip email campaign that sends a series of personalized emails over several days.
  • Scheduling emails only during business hours on specific weekdays in a chosen timezone.
  • Configuring tracking options like open and link tracking to monitor campaign engagement.
  • Automatically stopping the campaign if a lead replies or triggers an auto-reply.

Properties

Name Meaning
Campaign Name The name of the campaign to be created.
Schedule Name The name assigned to the campaign's sending schedule.
Start Time The daily start time (24-hour format) when emails can be sent.
End Time The daily end time (24-hour format) after which emails will not be sent.
Days of Week The days of the week on which emails should be sent. Options: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday.
Timezone The timezone used for scheduling the campaign's email sends. A comprehensive list of global timezones is available.
Additional Fields A collection of optional fields to further customize the campaign:
- Start Date Optional date/time to specify when the campaign should start.
- End Date Optional date/time to specify when the campaign should end.
- Lead Value Numeric value representing the worth of each positive lead generated by the campaign.
- Is Evergreen Boolean flag indicating if the campaign runs indefinitely without an end date.
- Email Gap (minutes) Minimum gap between sending consecutive emails in minutes.
- Random Wait Max (minutes) Maximum random wait time added to email sending delay in minutes.
- Text Only Whether to send emails as plain text only (no HTML).
- Daily Limit Maximum number of emails to send per day.
- Daily Max Leads Maximum number of new leads to contact per day.
- Link Tracking Enable or disable tracking of links clicked within emails.
- Open Tracking Enable or disable tracking of email opens.
- Stop on Reply Whether to stop the campaign for a lead once they reply.
- Stop on Auto Reply Whether to stop the campaign if an auto-reply is received from a lead.
- Stop for Company Whether to stop the campaign entirely for a company if any lead replies.
- Prioritize New Leads Whether to prioritize contacting new leads first.
- Match Lead ESP Whether to match leads based on their Email Service Provider.
- Insert Unsubscribe Header Whether to add an unsubscribe header in outgoing emails.
- Allow Risky Contacts Whether to allow sending emails to contacts flagged as risky.
- Disable Bounce Protect Whether to disable bounce protection mechanisms.
- Email List List of email accounts to use for sending campaign emails. Multiple values allowed.
- Email Tag List List of email tag UUIDs to associate with the campaign emails. Multiple values allowed.
- CC List List of email addresses to CC on all campaign emails. Multiple values allowed.
- BCC List List of email addresses to BCC on all campaign emails. Multiple values allowed.
- Email Sequence Steps Defines the sequence of emails to send in the campaign. Each step includes:
• Step Number (auto-calculated)
• Delay in days before sending this step (not required for first step)
• Email Subject with support for personalization variables and expressions
• Email Body supporting both Instantly variables and n8n expressions with preserved line breaks
- Auto Variant Select Trigger Option to automatically select email variants based on performance metrics: None, Click Rate, Open Rate, Reply Rate.

Output

The node outputs JSON data representing the response from the Instantly API after creating the campaign. This typically includes details about the newly created campaign such as its ID, name, schedule, and configuration settings.

No binary data output is indicated.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node uses the Instantly REST API endpoints to perform operations.
  • No additional external dependencies beyond the Instantly API and n8n core modules.

Troubleshooting

  • Limit Exceeded Error: When fetching accounts, the node enforces a maximum limit of 100 results due to API constraints. Setting a higher limit will cause an error.
  • Invalid Date Format: Dates must be in YYYY-MM-DD format. Invalid formats may cause warnings or errors.
  • API Request Failures: Network issues or invalid credentials will result in request failures. Ensure the API key is valid and network connectivity is stable.
  • Missing Required Fields: Omitting required properties like Campaign Name or Schedule Name will prevent successful campaign creation.
  • Pagination Limits: The node limits pagination to 1000 pages to avoid infinite loops; very large datasets might be truncated.

Links and References

Discussion