WaAPI icon

WaAPI

Interact with WaAPI API
Join our community

Actions85

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 channel data.

Common scenarios include:

  • Managing newsletter subscriptions by unsubscribing users from mailing lists.
  • Removing users from notification channels in an application.
  • Cleaning up channel data after unsubscription to maintain data hygiene.

For example, if you have a user subscribed to a newsletter channel identified by a unique channel ID, this operation will let you unsubscribe that user and optionally delete all related data for that channel.

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 Boolean flag indicating whether to delete all data associated with the channel upon unsubscription (true or false).

Output

The output JSON contains the response from the API after attempting to unsubscribe from the channel. This typically includes confirmation of the unsubscription status and any relevant metadata returned by the service.

If the node supports binary data output (not indicated here), it would represent any files or attachments related to the unsubscription process, but in this case, the output is purely JSON-based.

Dependencies

  • Requires an active API key credential to authenticate requests against the WaAPI service at https://waapi.app/api/v1.
  • The node depends on the external WaAPI service to perform the unsubscribe action.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing instance ID or channel ID can cause the operation to fail.
    • Network connectivity problems may prevent reaching the WaAPI endpoint.
    • Insufficient permissions or invalid API credentials will result in authentication errors.

  • Error messages:

    • "Unauthorized" or "Authentication failed": Check that the API key credential is correctly configured and valid.
    • "Channel not found": Verify that the provided channel ID exists and is correctly formatted.
    • "Invalid instance ID": Ensure the instance ID corresponds to a valid subscription or user instance.

Resolving these usually involves verifying input parameters, checking API credentials, and ensuring network access to the WaAPI service.

Links and References

Discussion