Subscribers

URL | Verbs | Fields | Error Codes

Use this API to work with subscribers. A subscriber is anyone who has interacted with your MojoTxt account.

URL Schemes

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}

Available Verbs

Verb Description
list Return a list of subscribers.

Subscriber Object Fields

Field Type (Limit) Required Notes
id Integer N/A Read-Only - A unique identifier for this subscriber.
PhoneNumber String (16) Yes Read-Only (After Creation) - The subscriber's phone number in international format (Ex. +12223334444).
FirstName String (50) Yes The subscriber's first name.
LastName String (50) Yes The subscriber's last name.
Address String (150) Yes The subscriber's mailing address.
City String (50) Yes The subscriber's city.
State String (2) Yes The subscriber's two-letter state abbreviation.
Zip String (10) Yes The subscriber's postal zipcode.
Email String (150) Yes The subscriber's email address.
Subscribed Timestamp N/A Read-Only - The time when this subscriber joined a subscription list. (Included only if the ListID parameter is provided.)
FirstUsage Timestamp Yes 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)
LastUsage Timestamp Yes 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)

Error Codes

Error Code Endpoint Description Notes
1000-1099 API Core (Multiple) See API Error Codes