HeyReach API icon

HeyReach API

Interact with HeyReach API

Overview

The node interacts with the HeyReach API to perform various operations on different resources. Specifically, for the Campaign resource with the Resume operation, it resumes a paused or stopped campaign by its unique identifier. This is useful in marketing automation workflows where campaigns may be temporarily halted and need to be restarted programmatically.

Practical examples include:

  • Automatically resuming a campaign after a scheduled pause.
  • Resuming campaigns based on external triggers or events in your workflow.
  • Managing campaign lifecycles dynamically without manual intervention.

Properties

Name Meaning
Campaign ID The ID of the campaign to resume

Output

The node outputs JSON data representing the response from the HeyReach API after attempting to resume the specified campaign. This typically includes details about the campaign's updated status and metadata confirming the resume action.

If the API supports binary data (not indicated here), it would be summarized accordingly, but this operation primarily deals with JSON responses.

Dependencies

  • Requires an API key credential for authenticating with the HeyReach API.
  • The base URL for API requests is https://api.heyreach.io/api/n8n.
  • Proper configuration of the HeyReach API credentials within n8n is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing Campaign ID will cause the operation to fail.
    • Authentication errors if the API key credential is not set or invalid.
    • Network connectivity problems preventing access to the HeyReach API.
  • Error messages:

    • "Campaign not found" indicates the provided Campaign ID does not exist.
    • "Unauthorized" or similar authentication errors suggest issues with the API key.
    • Timeout or connection errors indicate network or service availability problems.
  • Resolutions:

    • Verify the Campaign ID is correct and exists in HeyReach.
    • Ensure the API key credential is properly configured and has sufficient permissions.
    • Check network connectivity and retry if transient errors occur.

Links and References

Discussion