WaAPI icon

WaAPI

Interact with WaAPI API

Actions83

Overview

This node operation allows you to unsubscribe from a specific channel in the system. It is useful when you want to stop receiving updates or notifications from a particular channel, effectively removing your subscription and optionally deleting all associated data for that channel.

Common scenarios include:

  • Managing newsletter subscriptions by unsubscribing users from mailing lists.
  • Removing users from notification channels when they opt out.
  • Cleaning up channel data after unsubscription to maintain data hygiene.

For example, if you have a newsletter channel identified by a unique channel ID, this operation can be used to unsubscribe a user from that newsletter and delete their related data.

Properties

Name Meaning
Id The instance ID representing the subscription or user instance to unsubscribe.
Channel Id The identifier of the channel to unsubscribe from, typically formatted like <channelId>@newsletter.
Delete Channel Data A boolean flag indicating whether to delete all data associated with the channel upon unsubscription (true or false).

Output

The output JSON will contain the response from the API confirming the unsubscription action. This typically includes status information about the success or failure of the request. There is no binary data output for this operation.

Dependencies

  • Requires an API key credential for authenticating requests to the external WaAPI service.
  • The node uses the base URL https://waapi.app/api/v1 for API calls.
  • Proper configuration of credentials within n8n is necessary to authorize the unsubscribe request.

Troubleshooting

  • Missing or invalid Id: Ensure the "Id" property is provided and correctly corresponds to the subscription instance.
  • Invalid Channel Id format: The channel ID should follow the expected format (e.g., <channelId>@newsletter). Incorrect formatting may cause the API to reject the request.
  • Authentication errors: Verify that the API key credential is set up correctly and has sufficient permissions.
  • Network issues: Check connectivity to the API endpoint https://waapi.app/api/v1.
  • Delete Channel Data flag: If set to true, ensure you intend to permanently remove all channel-related data; otherwise, set it to false to retain data.

Links and References

Discussion