> For the complete documentation index, see [llms.txt](https://wiki.mobivate.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.mobivate.com/api-message-paramaters/subscription-api-restful.md).

# 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`.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://wiki.mobivate.com/api-message-paramaters/subscription-api-restful.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.