> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Unsubscribe

## What is Unsubscribe?

"Unsubscribe" means opting out. When this component is connected, the Rule-based Agent will add the current conversation's customer to the unsubscribe list. This way, when conducting mass broadcasts in the future, customers on the unsubscribe list can be filtered out.

## Applicable Scenarios

* When businesses conduct mass marketing campaigns, if some contacts have not purchased brand products or paid attention to brand information for a long time, these customers are likely to feel annoyed when receiving mass marketing messages and may complain about the company's WhatsApp account. High complaint rates can lead to the risk of account suspension. To avoid this as much as possible, businesses can **include an unsubscribe button in the broadcast message**. This way, when users no longer wish to receive similar marketing messages, they have a way to opt out, reducing the probability of user complaints. After setting up the unsubscribe button in the broadcast, it is also necessary to configure the Rule-based Agent based on the keywords presented by the unsubscribe button to trigger the unsubscribe process.

<Frame caption="Add a STOP quick reply to the template and configure a matching keyword in the agent.">
  <img src="https://mintcdn.com/lchnan/TsMGu8UTNQaUw-Rc/product-assets/english-help-demo-2026-09-23/template-stop-button-annotated.svg?fit=max&auto=format&n=TsMGu8UTNQaUw-Rc&q=85&s=74b012501a3ad881664927ddee278308" alt="Marketing template editor with a STOP quick-reply button." width="3024" height="1656" data-path="product-assets/english-help-demo-2026-09-23/template-stop-button-annotated.svg" />
</Frame>

<Frame caption="Route the opt-out reply to Unsubscribe after confirming the customer’s choice.">
  <img src="https://mintcdn.com/lchnan/TsMGu8UTNQaUw-Rc/product-assets/english-help-demo-2026-09-23/rule-complete-flow.png?fit=max&auto=format&n=TsMGu8UTNQaUw-Rc&q=85&s=4aead9ee880f3063f987b3194d005835" alt="Unsubscribe confirmation flow with both reply branches connected." width="3024" height="1656" data-path="product-assets/english-help-demo-2026-09-23/rule-complete-flow.png" />
</Frame>

* Businesses can also set up keyword-triggered Rule-based Agents, configuring multiple keywords that trigger the unsubscribe Rule-based Agent. This way, even if the message received by the user does not have an unsubscribe button, the Rule-based Agent can recognize messages expressing a desire to unsubscribe and add the user to the unsubscribe list.

<Frame caption="Use several opt-out keywords with the Containing rule.">
  <img src="https://mintcdn.com/lchnan/TsMGu8UTNQaUw-Rc/product-assets/english-help-demo-2026-09-23/rule-keywords-annotated.svg?fit=max&auto=format&n=TsMGu8UTNQaUw-Rc&q=85&s=7fbd06fc0506384980d18aee19a3288f" alt="Keyword trigger matching STOP and unsubscribe." width="3024" height="1656" data-path="product-assets/english-help-demo-2026-09-23/rule-keywords-annotated.svg" />
</Frame>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.