Subscribe

Add a person to a subscription list.

https://app.mojotxt.com/api/v1/{phone_number}/lists/subscribe/{ListID or Keyword}

Only add people who have agreed to receive messages from you. A person who has opted out can't be added (error 1015).

The PhoneNumber parameter is required. The person is added to your account if they aren't in it already. Subscribing someone who is already on the list changes nothing and still returns success.

This verb does not send the list's WelcomeMessage. Any automated (Relative) messages on the list start for the new subscriber.

Upon success, the server will return the subscriber's id in the "created_id" response field.

Parameters:

Parameters can be sent in the URL querystring or as POST variables.

ParameterOptionsDescription
PhoneNumberStringRequired. The person's 10-digit US or Canadian mobile number, in any format. SubscriberPhoneNumber is accepted as another name for this parameter.
FirstName, LastName, Email, Address, City, State, ZipStringOptional. Saved to the subscriber only where that field is currently blank. Existing values are not changed.

Example Request:

GET https://app.mojotxt.com/api/v1/+15555550100/lists/subscribe/134?PhoneNumber=%2B15555550101&FirstName=Jane

-or-

POST https://app.mojotxt.com/api/v1/+15555550100/lists/subscribe/134
DATA PhoneNumber=+15555550101
     FirstName=Jane

Example Result:

{
    "result": "success",
    "timestamp": 1793491200,
    "request": {
        "PhoneNumber": "+15555550101",
        "FirstName": "Jane",
        "object": "lists",
        "verb": "subscribe",
        "phone": "+15555550100",
        "id": "134"
    },
    "message": "The subscriber was added successfully.",
    "created_id": 6024
}