Find the answer you are looking for

Integrate the Engage API to store WhatsApp Campaign Opt-outs

To automate the process of storing user opt-outs from your WhatsApp Campaigns and keep the Opt-out List updated in real time, you need to integrate your Virtual Assistant with the Engage API. This process can be done in Studio for your available system or application.

Within the example JSON, you will find two possible interaction flows, one for Opt-out and another for Opt-in. Both flows illustrate how a Virtual Assistant can be integrated with the Engage API to store user preferences regarding campaign messages.

Keep in mind that these flows are just reference examples; you can customize the experience according to your needs and communication style.

➡ Download the JSON with the example flows here.

▶ To implement and test these flows in your environment, follow these steps:

  1. Download the example JSON
    Access the JSON file from the provided link and save it to your device.
  2. Import it into your Studio instance
    Log in to your Studio instance and use the import option to upload the flow from the downloaded JSON file.
  3. Add “Step In” nodes
    Insert Step In nodes at the necessary points of the flow to configure the Virtual Assistant's content according to your desired experience.
  4. Configure credentials in the "Prepare request credentials" nodes
    In these nodes, enter a valid username and password with access to the Engage platform.
  5. Add the X-Token in the "Prepare request Opt-in" and "Prepare request Opt-out" nodes
    In these nodes, you must enter the X-Token corresponding to your WhatsApp channel. You can request this token directly from your Customer Success Manager.

All set! 🎉
Once you complete these steps, your bot will be ready to test the experience of storing the user preferences for WhatsApp campaigns in the Audience section within Engage.

This website stores cookies on your computer. These cookies are used to collect information about how you interact with our website and allow us to remember you. We use this information in order to improve and customize your browsing experience and for analytics and metrics about our visitors both on this website and other media. To find out more about the cookies we use, see our Privacy Policy.

If you decline, your information won’t be tracked when you visit this website. A single cookie will be used in your browser to remember your preference not to be tracked.