# Subscription API (RESTFul)

Subscription requests can be sent to our gateway via a ***HTTP POST*** API request to our endpoint:

```
https://subscription-api.mobivate.com/subscriptions/<version>/<campaign_id>/
<method>
```

Your unique subscription API can be be found under your campaign configuration screen under the **API URL** section.

#### Request Parameters <a href="#request-parameters" id="request-parameters"></a>

| Parameter    | Description                                                                                                                                                                                            |
| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| version      | The version of the subscription api. Currently can only be `v1`.                                                                                                                                       |
| campaign\_id | Your unique Mobivate campaign id, for example: `0000d000a000d000c000e0f000b00`.                                                                                                                        |
| method       | <p>Which method you would like to call can be one of the following:</p><p><code>initiate</code>, <code>validate\_pin</code>, <code>unsubscribe</code>,<code>status</code> or <code>content.</code></p> |

#### JSON Parameters <a href="#json-parameters" id="json-parameters"></a>

When making this API request, you will need to also provide the following raw **JSON** parameters.

Copy

```
{
    "msisdn":"xxxxxxxxxxx",
    "keyword":"xxxxxxxx",
    "signature":"xxxxxxxxxxxxxxxxxx"
}
```

| Parameter | Description                                                                                                                                     |
| --------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
| msisdn    | The unqiue msisdn for this request, **must** be in international format.                                                                        |
| keyword   | Name of the traffic source/unqiue Mobivate keyword. Required except for in the status method.                                                   |
| signature | Unique parameter consisting of three values: **campaign\_id**, **msisdn** and **account\_id**. For example: `1af289e14aa593c843da7cd869a8e2f7`. |

{% hint style="warning" %}
**Please note**: The Signature parameter uses standard MD5 hashing algorithm. You must convert this before making the request. An example of the MD5 hashing can be found below.
{% endhint %}

#### Signature Conversion <a href="#signature-conversion" id="signature-conversion"></a>

The Signature field needs to be converted using a standard MD5 hashing algorithm in order for your request to work. For example:

**account\_id:** `43e36f54eef111e270639871000000f1`

**campaign\_id:** `c71e2c2ee68b410a82d6c5f910c2d428`

**msisdn:** `254700000000`

When run through a standard MD5 hashing algorithm would become:

**MD5 hash:** `1af289e14aa593c843da7cd869a8e2f7`.