Instantly icon

Instantly

Interact with Instantly API

Actions15

Overview

This node interacts with the Instantly API to update an existing email campaign's settings and schedule. It allows users to modify various campaign attributes such as name, sending limits, tracking options, email accounts used, and scheduling details. This is useful for marketers or sales teams who want to dynamically adjust their outreach campaigns without manually logging into the Instantly platform.

Typical use cases include:

  • Changing the daily email sending limit or maximum leads contacted per day.
  • Updating campaign timing, such as start/end dates and daily sending schedules.
  • Enabling or disabling tracking features like link or open tracking.
  • Adding or removing email accounts used for sending campaign emails.
  • Adjusting campaign behavior flags like stopping on reply or prioritizing new leads.

For example, a user might automate updating a campaign’s daily limit based on performance metrics or pause a campaign by setting an end date.

Properties

Name Meaning
Campaign The target campaign to update. Can be selected from a list of existing campaigns or specified by its unique ID.
Campaign Name New name for the campaign. Leave empty to keep the current name.
Additional Fields A collection of optional fields to update various campaign settings:
- Positive Lead Value Numeric value assigned to every positive lead.
- Is Evergreen Boolean flag indicating if the campaign runs continuously (evergreen).
- Email Gap (Minutes) Time gap in minutes between sending consecutive emails.
- Random Wait Max Maximum random wait time in minutes added between emails.
- Text Only Whether the campaign sends text-only emails (no HTML).
- Daily Limit Maximum number of emails sent per day.
- Daily Max Leads Maximum number of new leads contacted per day.
- Email Accounts List of email accounts used to send campaign emails. Selectable from available accounts.
- Email Tag List Comma-separated list of tag UUIDs applied to emails.
- CC List Comma-separated list of email addresses to CC on outgoing emails.
- BCC List Comma-separated list of email addresses to BCC on outgoing emails.
- Link Tracking Enable or disable tracking of links clicked in emails.
- Open Tracking Enable or disable tracking of email opens.
- Stop on Reply Whether to stop the campaign when a lead replies.
- Stop on Auto Reply Whether to stop the campaign on auto-replies.
- Stop for Company Whether to stop the campaign for the entire company/domain when a lead replies.
- Prioritize New Leads Whether to prioritize contacting new leads over existing ones.
- Match Lead ESP Whether to match leads by their Email Service Provider.
- Insert Unsubscribe Header Whether to insert an unsubscribe header in emails.
- Allow Risky Contacts Whether to allow sending to risky contacts.
- Disable Bounce Protect Whether to disable bounce protection mechanisms.
- Auto Variant Select Trigger Option to automatically select email variants based on click rate, open rate, reply rate, or none.
Campaign Schedule Collection defining campaign scheduling parameters:
- Start Date Optional start date/time for the campaign.
- End Date Optional end date/time for the campaign.
- Schedules One or more daily schedules specifying:
- Schedule Name Name of the schedule block.
- From Time Start time in HH:MM (24-hour) format.
- To Time End time in HH:MM (24-hour) format.
- Timezone Timezone for the schedule (many global timezone options available).
- Days of Week Days of the week when emails should be sent (Sunday=0 through Saturday=6). Default is Monday-Friday.

Output

The node outputs JSON data representing the updated campaign object returned by the Instantly API. This typically includes all campaign properties after the update, such as IDs, names, settings, and schedules.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Instantly API.
  • The node uses internal helper functions to make HTTP requests to Instantly endpoints.
  • The node depends on Instantly API availability and correct permissions to update campaigns.
  • For dropdown selections, it fetches lists of campaigns and email accounts via Instantly API calls.

Troubleshooting

  • Invalid Campaign ID: If the specified campaign ID does not exist or is incorrect, the API will return an error. Verify the campaign exists and the ID is correct.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions.
  • Limit Exceeded: Some numeric fields have constraints (e.g., daily limit max). Check API documentation for allowed ranges.
  • Date Format Issues: Dates must be in valid ISO or recognized formats. Invalid dates may cause errors or be ignored.
  • Network/Timeout Errors: Network issues can cause request failures. Retry or check connectivity.
  • Empty Required Fields: The campaign selection is required; ensure it is provided either by list or ID.

Links and References

Discussion