Instantly icon

Instantly

Interact with Instantly API

Overview

This node integrates with the Instantly API to update email account details. It allows users to modify various properties of an existing email account such as personal information, sending limits, tracking domain settings, and warmup configurations. This is useful in scenarios where you need to programmatically manage email accounts for marketing or outreach campaigns, ensuring that account settings stay up-to-date without manual intervention.

Practical examples include:

  • Adjusting daily sending limits based on campaign performance.
  • Enabling or disabling slow ramp-up of sending volume.
  • Updating tracking domain information to improve email analytics.
  • Configuring warmup parameters to gradually increase sending volume for new accounts.

Properties

Name Meaning
Email Account The target email account to update. Can be selected from a list of existing accounts or specified directly by email address.
Update Fields A collection of fields to update on the account:
- First Name The first name associated with the account.
- Last Name The last name associated with the account.
- Daily Limit The maximum number of emails that can be sent daily from this account. Default is 100.
- Tracking Domain Name The domain used for tracking email metrics.
- Tracking Domain Status The current status of the tracking domain (e.g., verified, pending).
- Enable Slow Ramp Boolean flag to enable gradual ramp-up of sending limits.
- Inbox Placement Test Limit The limit on the number of inbox placement tests allowed. Default is 10.
- Sending Gap (Minutes) The minimum gap in minutes between consecutive emails sent from this account. Range is 0 to 1440 minutes. Default is 10.
- Skip CNAME Check Boolean flag to skip DNS CNAME verification for the tracking domain.
- Remove Tracking Domain Boolean flag indicating whether to remove the tracking domain from the account.
- Warmup Configuration Nested collection for warmup settings:
-- Warmup Limit Daily limit for warmup emails. Default is 100.
-- Reply Rate Expected reply rate for warmup emails, between 0.0 and 1.0. Default is 0.1.
-- Warmup Custom Tag Custom tag to identify warmup emails. Default is "warmup".
-- Increment Option to enable or disable incremental warmup increases. Values: Disabled, Enabled.
- Warmup Daily Increase Number specifying how much to increase the warmup limit daily. Default is 5.

Output

The node outputs JSON data representing the updated account information returned by the Instantly API after the update operation. Each output item corresponds to one input item processed and contains the updated account details or error information if the update failed.

If binary data were involved (not indicated here), it would typically represent files or attachments related to the account, but this node focuses solely on JSON data.

Dependencies

  • Requires an active Instantly API key credential configured in n8n to authenticate API requests.
  • Relies on the Instantly API endpoints for accounts management.
  • Uses internal helper functions to perform HTTP requests and handle pagination/search for dropdowns.

Troubleshooting

  • Common Issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an email account that does not exist will result in errors.
    • Providing invalid values for numeric fields (e.g., negative numbers or out-of-range values) may cause API validation errors.
    • Network connectivity issues can prevent communication with the Instantly API.
  • Error Messages:

    • "Failed to load email accounts": Indicates problems fetching accounts for dropdown selection; check API credentials and network.
    • API response errors during update will be surfaced as node execution errors; review the error message for details.
  • Resolution Tips:

    • Verify API key validity and permissions.
    • Ensure email addresses are correct and correspond to existing accounts.
    • Validate all input fields conform to expected types and ranges.
    • Use the "Continue On Fail" option in the node to handle partial failures gracefully.

Links and References

Discussion