BizMail icon

BizMail

Interact with BizMail API

Actions5

Overview

This node integrates with the BizMail API to manage email marketing automations and contacts. Specifically, for the Automation - Create Subscriber operation, it allows users to add new subscribers to a specified automation workflow in BizMail. This is useful for automating subscriber management, such as adding new leads or customers to an email drip campaign or marketing automation sequence.

Practical examples include:

  • Automatically subscribing new users from a CRM or form submission into a BizMail automation.
  • Adding segmented contacts with custom merge fields to personalize email campaigns.
  • Integrating other systems to trigger subscriber creation without manual intervention.

Properties

Name Meaning
Automation Name or ID Select the target automation by name or UUID where the subscriber will be added.
Merge Fields Key-value pairs representing subscriber data fields (e.g., email, first name) to be merged into the subscriber record. Multiple fields can be added.

The "Merge Fields" property supports multiple entries, each consisting of:

  • Field Name or ID: The name or identifier of the merge field to set.
  • Value: The value to assign to that merge field.

Output

The node outputs a JSON object containing the response from the BizMail API after attempting to create the subscriber. This typically includes success status and any relevant data returned by the API about the created subscriber.

If the operation fails and "Continue On Fail" is enabled, the output will contain an error message describing the failure.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for BizMail with appropriate permissions.
  • Needs network access to BizMail's API endpoints.
  • The node uses HTTP requests to communicate with BizMail's REST API.
  • The user must configure the BizMail API credentials in n8n before using this node.

Troubleshooting

  • Missing Email Field: If the "emails" merge field is not provided or empty, the node throws an error stating that the email is required. Ensure the email address is included in the merge fields.
  • API Authentication Errors: If the API key or project token is invalid or missing, requests will fail. Verify credentials are correctly configured.
  • Invalid Automation UUID: Selecting or specifying an incorrect automation ID will cause the API call to fail. Use the dropdown or valid UUID expressions.
  • Network Issues: Connectivity problems to BizMail API endpoints will result in request failures.
  • To handle errors gracefully, enable "Continue On Fail" to allow the workflow to proceed even if some items fail.

Links and References


This summary focuses on the "Automation - Create Subscriber" operation as requested, based on static analysis of the provided source code and properties.

Discussion