Unsubscribing users from your service

This document will describe how to unsubscribe users from your service.

GET /api/doi/

Unsubscribe a user from your service that is using MNO Web Opt-In for Kenya.

Curl

curl -XGET -H "Content-type: application/json" 'https://hostname/api/doi/<account_id>/<api_key>/?source=<shortcode>&destination=<msisdn>&keyword=<kw>&frequency=7&campaign=Test&reference=<your internal reference>&stop=1'

Python

import requests

headers = {
    'Content-type': 'application/json',
}

response = requests.get(
    'https://hostname/api/doi/<account_id>/<api_key>/?source=<shortcode>&destination=<msisdn>&keyword=<kw>&frequency=7&campaign=TestCampaign&reference=<your internal reference>&stop=1',
    headers=headers,
)

Headers

Name	Value
Content-Type	application/json
Authorization	No Auth

Body

Parameter	Type	Example	Description
account_id	string	43e36f50aaf111e272639171000000a9	Your unique Mobivate account id.
password	string	3b41d767316541bacef19d1382ac1e12	Your unique associated Mobivate account api-key.
destination	integer	XX7432104492	The recipient you want to send this message to.
keyword	string	mv-100620006	Your unique Mobivate keyword for your service.
reference	string	MyRef	Your internal reference.
provider	string	safraicomke	The network provider this message will be sent via.
stop	string	stop=1	To indicate you intend to unsubscribe the user.

Additional Body

Parameter	Type	Example	Description
frequency	integer	7	Billing frequency in days. 7 would be equal to weekly.
campaign	string	TestCampaign	Your internal campaign reference.

Response

200

{
  "200": "MT-c65561314eb34088b6df42d8241aace0",
}

590

{
  "590": "SEND_FAILED: <Description>"
}

Please note, the description of the failed unsubscribe message will describe the reason for failing.