ZenderInstall

Overview

The node integrates with the Zender API to manage SMS campaigns and messages. Specifically, for the "SMS" resource and the "Stop Campaign" operation, it stops an active SMS campaign by sending a request to the Zender API to halt message dispatching for the specified campaign ID.

This node is useful in scenarios where you need to programmatically control SMS marketing or notification campaigns, allowing you to start, stop, or delete campaigns based on business logic or external triggers. For example, you might stop a campaign when a promotion ends or if certain conditions are met (e.g., budget limits reached).

Properties

Output

The output is a JSON object containing the response from the Zender API after attempting to stop the SMS campaign. This typically includes status information about whether the campaign was successfully stopped or any error details returned by the API.

Example output structure:

{
  "status": "success",
  "message": "Campaign stopped successfully",
  "campaignId": 123
}

(Note: Actual fields depend on the Zender API response.)

No binary data is output by this operation.

Dependencies

• Requires an API key credential for authenticating with the Zender API.
• The node uses HTTP GET requests to the Zender API endpoints.
• The base URL and API secret must be configured in the node credentials.
• No additional environment variables are required beyond the API credential.

Troubleshooting

• Common issues:

  • Invalid or missing Campaign ID: Ensure the Campaign ID provided exists and is correct.
  • Authentication errors: Verify that the API key credential is valid and has necessary permissions.
  • Network or connectivity problems: Check internet access and API endpoint availability.

• Error messages:

  • Errors returned from the API will be included in the node's output JSON under an error field if continueOnFail is enabled.
  • If the campaign does not exist or is already stopped, the API may return an error message indicating such; verify campaign status before stopping.

• Resolution tips:

  • Double-check the Campaign ID input.
  • Confirm API credentials and permissions.
  • Use the "Get Campaigns" operation to list existing campaigns and their statuses.

Links and References

• Zender API Documentation (generic link, replace with actual if available)
• n8n documentation on HTTP Request Node for understanding how HTTP calls work within nodes.