Initiate Subscription (API)

This document will detail how to initiate a subscription via RESTFul api.

To initiate a subscription via our RESTFul API you must make the following POST request:

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

Parameters

Successful response

If your initiate subscription was successful, you will receive a HTTP Status Code: 200:

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

Failed response

In case the campaign id is invalid or campaign is no longer available, the following status will be returned, HTTP Status Code: 404:

{
  "authenticated" : True,
  "valid_msisdn" : True,
  "valid_campaign" : False,
  "campaign_status" : Null,
  "campaign_name" : Null,
  "campaign_service" : Null,
  "state" : Null,
  "error" : "CampaignID '...' not found!",
  "reference": "AP:aaaaaaa-bbbbbbbbb-cccccccc"
}

Additional parameters/User Information

When submitting the subscription initiate response, you can also submit additional information that you have obtained about the subscriber. Here is a list of some of the additional parameters you can submit:

Last updated