Action broadcast__unsubscribe
System ID:
action_broadcast__unsubscribe
Description
Removes the user’s subscription to a broadcast topic. If topic_id is unset or equals "*", unsubscribes from all topics. Also available as alias action_subscription__remove.
Events (scenario branches)
| Event | When it occurs |
|---|---|
| success | Unsubscribe completed successfully |
| error | Unsubscribe failed (module unavailable or status error) |
Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
topic_id |
string | no | "*" |
Topic to unsubscribe from; "*" or missing — all topics |
Configuration example
{
"topic_id": "newsletter"
}
Unsubscribe from all topics:
{
"topic_id": "*"
}