Subscribers

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.

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

VerbDescription
listReturn a list of subscribers.

Subscriber Object Fields

FieldTypeNotes
idIntegerRead-Only - A unique identifier for this subscriber.
PhoneNumberStringRead-Only - The subscriber's phone number in international format (Ex. +15555550101).
FirstNameStringThe subscriber's first name.
LastNameStringThe subscriber's last name.
EmailStringThe subscriber's email address.
AddressStringThe subscriber's mailing address.
CityStringThe subscriber's city.
StateStringThe subscriber's two-letter state abbreviation.
ZipStringThe subscriber's postal zipcode.
SubscribedUNIX Timestamp (Integer)Read-Only - The time when this subscriber joined a subscription list. (Included only if the ListID parameter is provided.)
FirstUsageUNIX 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.)
LastUsageUNIX 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 Codes

Error CodeEndpointDescriptionNotes
1000-1099API Core(Multiple)See API Error Codes
1301SubscribersList object does not exist.The ListID you specified doesn't exist, or belongs to a different account.