URL | Verbs | Fields | Error Codes
Use this API to work with subscribers. A subscriber is anyone who has interacted with your MojoTxt account. To add a person to a subscription list, use the lists subscribe verb.
To work with all subscribers in your account.
https://app.mojotxt.com/api/v1/subscribers/{verb}
To work with subscribers who have interacted with a specific phone number.
https://app.mojotxt.com/api/v1/{phone_number}/subscribers/{verb}
| Verb | Description |
|---|---|
| list | Return a list of subscribers. |
| Field | Type | Notes |
|---|---|---|
| id | Integer | Read-Only - A unique identifier for this subscriber. |
| PhoneNumber | String | Read-Only - The subscriber's phone number in international format (Ex. +15555550101). |
| FirstName | String | The subscriber's first name. |
| LastName | String | The subscriber's last name. |
| String | The subscriber's email address. | |
| Address | String | The subscriber's mailing address. |
| City | String | The subscriber's city. |
| State | String | The subscriber's two-letter state abbreviation. |
| Zip | String | The subscriber's postal zipcode. |
| Subscribed | UNIX Timestamp (Integer) | Read-Only - The time when this subscriber joined a subscription list. (Included only if the ListID parameter is provided.) |
| FirstUsage | UNIX Timestamp (Integer) | Read-Only - The first time this subscriber sent or received a message with this phone number. (Included only if the {phone_number} is included in the URL and the ListID parameter is not provided.) |
| LastUsage | UNIX Timestamp (Integer) | Read-Only - The most recent time this subscriber sent or received a message with this phone number. (Included only if the {phone_number} is included in the URL and the ListID parameter is not provided.) |
| Error Code | Endpoint | Description | Notes |
|---|---|---|---|
| 1000-1099 | API Core | (Multiple) | See API Error Codes |
| 1301 | Subscribers | List object does not exist. | The ListID you specified doesn't exist, or belongs to a different account. |