HeyReach APIInstall

Overview

The node integrates with the HeyReach API to manage campaigns, specifically allowing users to pause an active campaign. This operation is useful in marketing automation scenarios where a campaign needs to be temporarily halted without deleting it, for example, to adjust content, timing, or targeting criteria before resuming.

Practical examples include:

• Pausing a running email marketing campaign during a holiday period.
• Temporarily stopping a social media outreach campaign to update messaging.
• Halting a campaign due to budget constraints or performance review.

Properties

Output

The node outputs JSON data representing the response from the HeyReach API after attempting to pause the specified campaign. This typically includes confirmation of the campaign's paused status and any relevant metadata returned by the API.

No binary data output is involved.

Dependencies

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

Troubleshooting

• Invalid Campaign ID: If the provided 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.
• Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key is correctly configured and has sufficient permissions.
• Network Issues: Connectivity problems can lead to request timeouts or failures. Check network access to the HeyReach API endpoint.
• API Rate Limits: Excessive requests might trigger rate limiting. Monitor usage and space out requests if needed.

Links and References

• HeyReach API Documentation (general reference for API endpoints and usage)
• n8n documentation on creating and using API credentials