Unsubscribing Users (API)

This document aims to detail how to unsubscribe users via our RESTFul api.

You can also unsubscribe your users via our RESTFul api with the following POST request:

Request

https://subscription-api.mobivate.com/subscriptions/v1/<campaign_id>/unsubscribe

JSON Body

{
    "msisdn":"xxxxxxxxxxx"
    "signature":"xxxxxxxxxxxxxxxxxx"
}

Parameters

Parameter	Description
msisdn	The unique MSISDN you are trying to unsubscribe.
signature	Unique parameter consisting of three values: campaign_id, msisdn and account_id. For example: 1af289e14aa593c843da7cd869a8e2f7.

To read more about how to generate signatures, click here.

Successful response

If your user has been unsubscribed successfully you will receive the following response, HTTP Status Code 200:

{
  "authenticated" : True,
  "valid_msisdn" : True,
  "valid_campaign" : True,
  "campaign_status" : "active",
  "campaign_name" : "Test Campaign",
  "campaign_service" : "12345",
  "state" : "unsubscribed",
  "error" : Null,
  "reference": "AP:aaaaaaa-bbbbbbbbb-cccccccc"
}