HeyReach API icon

HeyReach API

Interact with HeyReach API

Overview

The "Stop Lead" operation in the Campaign resource allows users to halt or remove a specific lead from an active campaign within the HeyReach platform. This is useful when a lead should no longer receive campaign communications, for example, if the lead has opted out, converted, or is no longer relevant.

Practical scenarios include:

  • Stopping outreach to a LinkedIn lead who has responded negatively.
  • Removing leads that have already been contacted through other channels.
  • Managing campaign lists dynamically by excluding certain leads based on updated criteria.

Properties

Name Meaning
Campaign ID The numeric identifier of the campaign from which the lead will be stopped.
Lead Member ID The LinkedIn Member ID (a string) of the lead to stop; also known as the lead's LinkedIn ID.
Lead URL The LinkedIn profile URL of the lead, e.g., https://www.linkedin.com/in/john-doe/.

Output

The node outputs JSON data representing the result of the stop lead operation. Typically, this includes confirmation details such as success status, any messages returned by the API, and possibly the updated state of the lead within the campaign.

If the operation supports binary data output, it would generally relate to attachments or files associated with the lead or campaign, but this is not indicated here.

Dependencies

  • Requires an API key credential for authenticating with the HeyReach API.
  • The node communicates with the HeyReach API endpoint at https://api.heyreach.io/api/n8n.
  • Proper configuration of the HeyReach API credentials in n8n is necessary.

Troubleshooting

  • Invalid Campaign ID: If the campaign ID does not exist or is incorrect, the API may return an error indicating the campaign was not found. Verify the campaign ID before running the node.
  • Lead Not Found: Providing an invalid or non-existent LinkedIn Member ID or Lead URL can cause the operation to fail. Ensure the lead identifiers are accurate.
  • Authentication Errors: Missing or invalid API credentials will prevent the node from executing successfully. Confirm that the API key is correctly set up.
  • Network Issues: Connectivity problems with the HeyReach API endpoint can cause timeouts or failures. Check network access and API availability.

Links and References

Discussion