Page cover

user-plusAdd a Subscriber

Learn how to use the Mobile Text Alerts API to add a subscriber to your account

The Mobile Text Alerts API allows you to view, add, edit, and remove subscribers from your account just like you can from the platform dashboard pagearrow-up-right. This page will guide you through adding a subscriber with the API.

circle-info

Already have a contact list? You can import contacts in bulkarrow-up-right via a spreadsheet or integration instead of adding them individually through the API.

Add a Subscriber with the Mobile Text Alerts API

Subscribers can be added via the API with a POST request to the /subscribers endpoint. A phone number (number) or email address (email) is required. If you add a phone number or email of a subscriber that already exists on the account, this will update the existing subscriber with any changes.

Example request to add a subscriber

Below you can see example POST requests to the /subscribers endpoint to add a new subscriber:

curl --location --request POST 'https://api.mobile-text-alerts.com/v3/subscribers' \
  --header 'Authorization: Bearer 89fa747a-e01b-5940-99c2-4e96fa996258' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "firstName": "FirstName",
    "lastName": "LastName",
    "number": 8002223333,
    "email": "[email protected]"
  }'

To view all possible request parameters see: Create Subscriber API Endpoint

Example Response

If valid, a response will be returned with the message: "Subscriber created successfully."

Create Subscriber

post

Add a new subscriber. If given a phone number or email that already exists tied to the same account, updates the existing subscriber with new information

Required Fields: email or number

Rate Limiting

This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests every 15 seconds

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

SubscriberRequest

firstNamestringRequired
lastNamestringRequired
emailstringRequired
numbernumberRequired
groupIdsnumber[]Required
employeeNumberstringRequired
welcomeMessagestringRequired
Responses
chevron-right
200

Success

application/json
post
/subscribers

More Subscriber Actions

Last updated

Was this helpful?