HeyReach APIInstall

Overview

This node integrates with the HeyReach API to manage lists among other resources. Specifically, the "Create Empty" operation under the "List" resource allows users to create a new empty list in HeyReach. This is useful for scenarios where you want to programmatically set up a new user or company list before populating it with contacts or data.

Practical examples include:

• Creating a new user list to segment contacts for targeted campaigns.
• Setting up an empty company list to organize business leads separately.
• Automating list creation as part of a workflow that manages marketing or sales data.

Properties

Output

The node outputs JSON data representing the newly created list object returned by the HeyReach API. This typically includes details such as the list ID, name, type, and possibly metadata about creation time or status.

No binary data output is involved in this operation.

Dependencies

• Requires an active connection to the HeyReach API.
• Needs an API key credential configured in n8n for authentication with HeyReach.
• The base URL used for requests is https://api.heyreach.io/api/n8n.
• The node sends and expects JSON-formatted data.

Troubleshooting

• Common issues:

  • Missing or invalid API credentials will cause authentication failures.
  • Providing an empty or invalid list name may result in validation errors from the API.
  • Selecting an unsupported list type value could cause the request to fail.

• Error messages:

  • Authentication errors usually indicate problems with the API key; verify the credential setup.
  • Validation errors from the API often mention missing required fields like "listName".
  • Network or timeout errors suggest connectivity issues; check your internet connection and API availability.

Links and References

• HeyReach API Documentation (general reference for API endpoints and data structures)
• n8n Documentation on Creating Custom Nodes