Instantly icon

Instantly

Interact with Instantly API

Overview

This node interacts with the Instantly API to update an existing campaign's details. It allows users to modify specific fields of a campaign, such as its name or associated email account ID. This operation is useful when you need to change campaign settings without recreating it, for example, updating the campaign name to reflect a new marketing focus or switching the email account used for sending.

Practical examples:

  • Renaming a campaign after rebranding.
  • Changing the email account linked to a campaign due to organizational changes.

Properties

Name Meaning
Campaign ID The unique identifier of the campaign to update.
Update Fields Collection of fields to update in the campaign. Options include:
- Campaign Name: New name for the campaign.
- Email Account ID: New email account ID to associate with the campaign.

Output

The node outputs JSON data representing the updated campaign object returned by the Instantly API after the update operation. This typically includes the campaign's current properties such as its ID, name, email account ID, and any other relevant metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Instantly API.
  • Needs an API authentication token configured in n8n credentials to authorize requests.
  • Uses the Instantly API endpoint /api/v2/campaigns/{campaignId} with HTTP PATCH method for updates.

Troubleshooting

  • Common issues:

    • Providing an invalid or non-existent Campaign ID will result in an error from the API indicating the campaign was not found.
    • Omitting all update fields will cause the request to send an empty payload, which may lead to no changes or an error depending on the API behavior.
    • Incorrect or expired API credentials will cause authentication failures.
  • Error messages and resolutions:

    • "Campaign not found": Verify that the Campaign ID is correct and exists in your Instantly account.
    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly set up and has proper permissions.
    • "Invalid request payload": Ensure at least one field in "Update Fields" is provided and valid.

Links and References

Discussion