Subscribe API

subscribe

Synopsis:

This API will subscribe users to a particular campaign. Once a user is subscribed to a campaign they will receive all auto responders and scheduled messages for that campaign until they are unsubscribed. You may not import via CSV someone who has unsubscribed themselves from a campaign however you may re-subscribe someone who has unsubscribed through this API.

Request: XML

<REQUEST>
    <ACTION>subscribe</ACTION>
    <API_KEY>YourApiKey</API_KEY>
    <CAMPAIGNREF>CampaignReferenceID</CAMPAIGNREF>
    <MOBILE>Phone Number to subscribe</MOBILE>
    <DATA>
        <FIRST_NAME>First Name</FIRST_NAME>
        <LAST_NAME>Last Name</LAST_NAME>
        <GENDER>Gender</GENDER>
        ...
    </DATA>
    <TIMEZONE>Timezone abbreviation: EST, CST, MST, PST, etc.</TIMEZONE>
</REQUEST>

Click here for more timezone options. Note that the difference between standard and daylight time does not matter here. The system will use the current time offset for the geographic region.

Request Parameters:

Response Parameters:

Request Example: XML

<REQUEST>
    <ACTION>subscribe</ACTION>
    <API_KEY>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx</API_KEY>
    <CAMPAIGNREF>1116</CAMPAIGNREF>
    <MOBILE>11111111111</MOBILE>
    <DATA>
        <FIRST_NAME>John</FIRST_NAME>
        <LAST_NAME>Smith</LAST_NAME>
        <AGE>29</AGE>
        <PET>Dog</PET>
    </DATA>
</REQUEST>

Response Example: Success

<RESPONSE>
    <STATUS>Success</STATUS>
    <CAMPAIGNREF>1116</CAMPAIGNREF>
    <MOBILE>11111111111</MOBILE>
</RESPONSE>

Response Example: Failure

<RESPONSE>
    <STATUS>Failure</STATUS>
    <ERRORCODE>E721</ERRORCODE>
    <MOBILE>11111111111</MOBILE>
    <CAMPAIGNREF>1116</CAMPAIGNREF>
    <ERRORINFO>Invalid campaignref</ERRORINFO>
</RESPONSE>

Postback Notification:

Upon subscribing a number successfully through any channel, the system will generate a notification. For more details please visit the Mobile Subscribe section of the Opt-in Status Postback documentation.

General Error Codes:

Related Error Codes:

Timezones: