Create Free API Account

Manage Subscribers

View all the ways you can interact with the API to manage your subscribers

List all Subscribers API Endpoint

GET /subscribers

List all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.

Rate Limit

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 per 15 seconds.

Example Request

curl --location 'https://api.mobile-text-alerts.com/v3/subscribers' \
  --header 'Authorization: Bearer 6078eebf-7661-5458-330e-74cd055a0b03'

Example Successful Response

{"data":
    {"rows":[
        {"id":109021626,
        "firstName":"Test",
        "lastName":"Example",
        "email":"[email protected]",
        "number":0,"date":"2025-03-20T19:09:38.000Z",
        "countryId":null,"groups":[],
        "subscriberFieldData":[],
        "signupMethod":11,
        "longNumber":0,
        "carrierId":41},
        {"id":109021633,
        "firstName":"FirstName",
        "lastName":"LastName",
        "email":"[email protected]",
        "number":1112228904,"e164Number":"+1112228904",
        "date":"2025-03-21T15:50:54.000Z",
        "countryId":209,"groups":[],
        "subscriberFieldData":[],
        "signupMethod":5,
        "longNumber":1112228904,
        "carrierId":41},
    "page":0,"pageSize":25,"total":2}}

List Subscribers

get

List all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.

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
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
allSubscribersbooleanOptional
Responses
200

Success

application/json
Responseall of
get
/subscribers
GET /v3/subscribers HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "rows": [
      {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "number": 1,
        "e164Number": "text",
        "date": "2025-10-24T18:56:33.030Z",
        "countryId": 1,
        "groups": [
          {
            "id": 1,
            "name": "text",
            "addedToGroupAt": "2025-10-24T18:56:33.030Z"
          }
        ],
        "subscriberFieldData": [
          {
            "id": 1,
            "subscriberFieldId": 1,
            "data": "text"
          }
        ],
        "signupMethod": 1,
        "longNumber": 1,
        "carrierId": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Create Subscriber API Endpoint

POST /subscribers

Used to add a new subscriber.

If given a phone number or email that already exists tied to the same account, this endpoint will update the existing subscriber with new information.

Rate Limit

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 per 15 seconds.

If creating many subscribers at one time, the Bulk Create endpoint can be used to batch large updates, this can save on both request round trip time and overall API call volume.

Body

Required Fields: email or number

Name
Type
Description

firstName

string

First name of the subscriber.

lastName

string

Last name of the subscriber.

number(required if no email)

number

Phone number of the subscriber.

email (required if no number)

string

Email address of the subscriber.

e164Number

string

E.164 international telephone number of the subscriber. If supplied, will be used over number .

E.164 Format:

[+] [country code] [subscriber number including area code] (max. 15 digits)

groupIds

number[]

List of group ids of the groups the subscriber belongs to.

subscriberFields

dictionary: subscriberFieldIds:string as the keys and data: string corresponding values

A dictionary of key value pairs of additional custom subscriber attributes for the subscriber.

Example: 

"subscriberFields": {
    "2000": "January 1st, 2000",
    "2001": "Custom Field Data"
}

Example Request

curl -XPOST --location '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]" 
}'

Example Successful Response

{
  "data": {
    "id": 100,
    "firstName": "firstName",
    "lastName": "lastName",
    "email": "[email protected]",
    "number": 1234567890,
    "date": "2021-01-01T00:00:00.000Z",
    "countryId": 0,
    "groups": [
      {
        "id": 100,
        "name": "Group A"
      },
      {
        "id": 101,
        "name": "Group B"
      },
      {
        "id": 102,
        "name": "Group C"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1000,
        "subscriberFieldId": 2000,
        "data": "January 1st, 2000"
      },
      {
        "id": 1001,
        "subscriberFieldId": 2001,
        "data": "Custom Field Value"
      }
    ],
    "signupMethod": 3,
    "longNumber": 1234567890
  }
}

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
Body

SubscriberRequest

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

Success

application/json
Responseall of
post
/subscribers
POST /v3/subscribers HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "number": 1,
  "groupIds": [
    1
  ],
  "subscriberFields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "employeeNumber": "text",
  "welcomeMessage": "text"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "number": 1,
    "e164Number": "text",
    "date": "2025-10-24T18:56:33.030Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2025-10-24T18:56:33.030Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Update Subscriber API Endpoint

PATCH /subscribers/{idOrNumberOrEmail}

Update details of a specific subscriber. If a field isn't specified, then original value is retained, except for groups , where the subscriber will be added as a member to the groups specified and removed from all other groups.

If given a phone number or email that already exists, then this endpoint will return success: false.

Path Variable

When making the request, the Subscriber Id, Phone Number or email must be included as an identifier in the path:

  • idOrNumber: string

  • subscriberId: number

Rate Limit

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 per 15 seconds.

If updating many subscribers at one time, the Bulk Update endpoint can be used to batch large updates, this can save on both request round trip time and overall API call volume.

Body (all optional)

Name
Type
Description

firstName

string

First name of the subscriber.

lastName

string

Last name of the subscriber.

number

number

Phone number of the subscriber.

email

string

Email address of the subscriber.

e164Number

string

E.164 international telephone number of the subscriber. If supplied, will be used over number .

E.164 Format:

[+] [country code] [subscriber number including area code] (max. 15 digits)

groupIds

number[]

List of group ids of the groups the subscriber belongs to.

subscriberFields

dictionary: subscriberFieldIds:string as the keys and data: string corresponding values

A dictionary of key value pairs of additional custom subscriber attributes for the subscriber.

Example: 

"subscriberFields": {
    "2000": "January 1st, 2000",
    "2001": "Custom Field Data"
}

Example Request

curl -PATCH --location 'https://api.mobile-text-alerts.com/v3/subscribers/100’ \
  --header 'Authorization: Bearer 89fa747a-e01b-5940-99c2-4e96fa996258' 
  --header 'Content-Type:application/json' \
  --data-raw '{"firstName": "FirstName1”, "lastName": "LastName1” }'

Example Successful Response

{"message":"Subscriber updated successfully.",
    "data":{
        "id":109021633,
        "firstName":"FirstName",
        "lastName":"LastName",
        "email":"[email protected]",
        "number":12223334444,
        "e164Number":"+12223334444",
        "date":"2025-03-21T15:50:54.000Z",
        "countryId":209,"groups":[],
        "subscriberFieldData":[],
        "signupMethod":5,
        "longNumber":2069638904,
        "carrierId":41
        }
}

Update Subscriber

patch

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
Path parameters
idOrNumberOrEmailstringRequired
Body

SubscriberRequest

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

Success

application/json
Responseall of
patch
/subscribers/{idOrNumberOrEmail}
PATCH /v3/subscribers/{idOrNumberOrEmail} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 181

{
  "firstName": "text",
  "lastName": "text",
  "email": "text",
  "number": 1,
  "groupIds": [
    1
  ],
  "subscriberFields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "employeeNumber": "text",
  "welcomeMessage": "text"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "number": 1,
    "e164Number": "text",
    "date": "2025-10-24T18:56:33.030Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2025-10-24T18:56:33.030Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Get Subscriber API Endpoint

GET /subscribers/{idOrNumber}

List the data for just the specified (using the path variable) subscriber.

Path Variable

When making the request, the Subscriber Id or Phone Number must be included as an identifier in the path:

  • idOrNumber: string

  • subscriberId: number

Rate Limit

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 per 15 seconds.

Example Request

curl --location 'https://api.mobile-text-alerts.com/v3/subscribers/100 \
  --header 'Authorization: Bearer 6078eebf-7661-5458-330e-74cd055a0b03'

Example Successful Response

{"data":
    {"id":100,
    "firstName":"FirstName",
    "lastName":"LastName",
    "email":"[email protected]",
    "number":1112228904,"e164Number":"+1112228904",
    "date":"2025-03-21T15:50:54.000Z",
    "countryId":209,
    "groups":[],
    "subscriberFieldData":[],
    "signupMethod":5,
    "longNumber":2069638904,
    "carrierId":41
    }
}

Get Subscriber

get

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
Path parameters
idOrNumberOrEmailstringRequired
Responses
200

Success

application/json
Responseall of
get
/subscribers/{idOrNumberOrEmail}
GET /v3/subscribers/{idOrNumberOrEmail} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "number": 1,
    "e164Number": "text",
    "date": "2025-10-24T18:56:33.030Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2025-10-24T18:56:33.030Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Delete Subscriber API Endpoint

DEL /subscribers/{idOrNumber}

Remove the specified (using the path variable) subscriber.

Path Variable

When making the request, the Subscriber Id or Phone Number must be included as an identifier in the path:

  • idOrNumber: string

  • subscriberId: number

A 404 response will be returned if this identifier is not found.

Rate Limit

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 per 15 seconds.

Example Request

curl --location --request DELETE 'https://api.mobile-text-alerts.com/v3/subscribers/100'
  --header 'Authorization: Bearer 6078eebf-7661-5458-330e-74cd055a0b03'

Example Successful Response

{"message":"Subscriber deleted successfully."}

Delete Subscriber

delete

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
Path parameters
idOrNumberOrEmailstringRequired
Responses
200

Success

application/json
delete
/subscribers/{idOrNumberOrEmail}
DELETE /v3/subscribers/{idOrNumberOrEmail} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

Visit Subscribers for full API reference.

PreviousReceive and Reply to MessagesNextAssign Custom Subscriber Attributes

Last updated

Was this helpful?