TouchBasePro icon

TouchBasePro

Interact with TouchBasePro API for Email and WhatsApp operations

Actions6

Overview

This node integrates with the TouchBasePro API to manage email marketing lists and subscribers. Specifically, the Create List operation under the Email resource allows users to create a new email list with customizable fields. This is useful for organizing contacts into segmented groups for targeted email campaigns.

Typical use cases include:

  • Creating a new mailing list for a specific campaign or audience.
  • Defining custom fields (e.g., birthday, membership level) to collect additional subscriber data.
  • Setting field properties such as type, visibility, uniqueness, and whether they are required.

For example, a marketing team can create a "Newsletter Subscribers" list with custom fields like "Subscription Date" (date), "Preferred Topics" (multi-select), and "VIP Status" (boolean), enabling personalized communication.

Properties

Name Meaning
List Name The name of the new email list to be created.
Custom Fields A collection of custom fields to define additional data points for subscribers in the list. Each field includes:
- Field Name: Identifier for the field.
- Field Type: Data type of the field; options are Date, Number, Select Many, Select One, Text.
- Options: Comma-separated values for select-type fields.
- Required: Whether this field must be filled by subscribers.
- Unique Identifier: Marks the field as a unique key.
- Visible: Whether the field is visible to subscribers or only internal.

Output

The node outputs JSON data representing the result of the list creation operation. This typically includes details about the newly created list such as its ID, name, and the defined custom fields with their configurations.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the TouchBasePro API.
  • The node depends on the TouchBasePro service being accessible and properly configured.
  • No additional environment variables are explicitly required beyond the API authentication setup.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Providing invalid field types or malformed options for custom fields may result in API errors.
    • Attempting to create a list with a name that already exists might cause conflicts depending on the API behavior.

  • Error Messages:

    • "Operation "createList" not implemented for resource "email": Indicates a misconfiguration or unsupported operation; ensure the correct resource and operation are selected.
    • API errors related to validation will usually specify which field or parameter caused the issue; verify all required fields are correctly set.

  • Resolution Tips:

    • Double-check API credentials and permissions.
    • Validate all input parameters, especially custom fields and their options.
    • Use unique list names to avoid duplication conflicts.

Links and References

Discussion