WhatsApp Opt-in/Opt-out API

This page talks about WhatsApp opt-in/opt-out API

Overview

Use Lemnisk WhatsApp opt-in/opt-out API to update the opt-in and opt-out status of your users. It is mandatory to receive user consent before you can reach out to your users via WhatsApp. With Lemnisk, you can reach out to your customers via WhatsApp with any of the WSPs.

Lemnisk internally maintains user opt-ins and opt-outs to show user reachability and track opt-ins and opt-outs on a daily/weekly/monthly basis. Lemnisk will only reach out to users via WhatsApp if the user is marked as opt-in in the user profile stored at Lemnisk CDP.

Making a Request

Endpoint

India (MU)

https://mu-pl.lemnisk.co/analyze/whatsapp

HTTP Specification:

GET /analyze/whatsapp HTTP/1.1
Host: mu-pl.lemnisk.co

Other region

https://us-pl.lemnisk.co/analyze/whatsapp

HTTP Specification:

GET /analyze/whatsapp HTTP/1.1
Host: us-pl.lemnisk.co

Query Params

A sample payload is given below:

https://mu-pl.lemnisk.co/analyze/whatsapp?cid={cid}&phone={phone}&status={status}&cb={cookie}

The parameter definition for the above fields is provided below:

Parameter	Description
cid	Account ID. Please contact your account manager to retrieve your account ID.
phone	The phone number that you want to mark as opt-in. Should be in E.164 format.
status	"OP" for opt-in and "OO" for opt-out (without quotes)
cb	User cookie. Required if the consent is directly being received via online activity so that profile merge can happen.

Sample Request

Opt-in a user:

curl --location --request GET 'https://mu-pl.lemnisk.co/analyze/whatsapp?cid=4812&phone=9185xxxxxxxx&status=OP&cb=viz_641d71936c1b5' \

Opt-out a user:

curl --location --request GET 'https://mu-pl.lemnisk.co/analyze/whatsapp?cid=4812&phone=9185xxxxxxxx&status=OO&cb=viz_641d71936c1b5' \