Manage Subscribers

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

List all Subscribers API Endpoint

GET /subscribers

List and search subscribers. Results include subscribers where the query value matches first name, last name, number, email, or custom subscriber fields. You can also apply filters for these same 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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumberOptional

pageSizenumberOptional

sortBystringOptional

sortDirectionstring · enumOptionalPossible values:

querystringOptional

allSubscribersbooleanOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

application/json

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": "2026-02-07T06:27:30.383Z",
        "countryId": 1,
        "groups": [
          {
            "id": 1,
            "name": "text",
            "addedToGroupAt": "2026-02-07T06:27:30.383Z"
          }
        ],
        "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 you provide a phone number or email that already exists on the same account, this endpoint will update the existing subscriber with new information.

Rate Limit

If you are creating many subscribers at one time, use the Bulk Create endpoint to batch updates. This can save on 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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

SubscriberRequest

firstNamestringRequired

lastNamestringRequired

emailstringRequired

numbernumberRequired

groupIdsnumber[]Required

employeeNumberstringRequired

welcomeMessagestringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

application/json

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": "2026-02-07T06:27:30.383Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2026-02-07T06:27:30.383Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Update Subscriber API Endpoint

PATCH /subscribers/{idOrNumberOrEmail}

Update details for a specific subscriber. If a field isn't specified, the original value is retained. The exception is groups, where the subscriber is added to the specified groups and removed from all other groups.

If you provide a phone number or email that already exists, this endpoint returns 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

If you are updating many subscribers at one time, use the Bulk Update endpoint to batch updates. This can save on 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

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 --request 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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idOrNumberOrEmailstringRequired

Body

SubscriberRequest

firstNamestringRequired

lastNamestringRequired

emailstringRequired

numbernumberRequired

groupIdsnumber[]Required

employeeNumberstringRequired

welcomeMessagestringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

application/json

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": "2026-02-07T06:27:30.383Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2026-02-07T06:27:30.383Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Get Subscriber API Endpoint

GET /subscribers/{idOrNumber}

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

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

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idOrNumberOrEmailstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

application/json

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": "2026-02-07T06:27:30.383Z",
    "countryId": 1,
    "groups": [
      {
        "id": 1,
        "name": "text",
        "addedToGroupAt": "2026-02-07T06:27:30.383Z"
      }
    ],
    "subscriberFieldData": [
      {
        "id": 1,
        "subscriberFieldId": 1,
        "data": "text"
      }
    ],
    "signupMethod": 1,
    "longNumber": 1,
    "carrierId": 1
  }
}

Delete Subscriber API Endpoint

DELETE /subscribers/{idOrNumber}

Remove the specified subscriber (using the path variable).

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

Example Request

curl --request DELETE --location '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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idOrNumberOrEmailstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

429

RateLimitError

application/json

500

InternalServerError

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 Messages NextAssign Custom Subscriber Attributes

Last updated 21 days ago

Was this helpful?

hashtagList all Subscribers API Endpoint

hashtagExample Request

hashtagList Subscribers

hashtagRate Limiting

hashtagCreate Subscriber API Endpoint

hashtagExample Request

hashtagCreate Subscriber

hashtagRate Limiting

hashtagUpdate Subscriber API Endpoint

hashtagExample Request

hashtagUpdate Subscriber

hashtagRate Limiting

hashtagGet Subscriber API Endpoint

hashtagExample Request

hashtagGet Subscriber

hashtagRate Limiting

hashtagDelete Subscriber API Endpoint

hashtagExample Request

hashtagDelete Subscriber

hashtagRate Limiting

List all Subscribers API Endpoint

Example Request

List Subscribers

Rate Limiting

Create Subscriber API Endpoint

Example Request

Create Subscriber

Rate Limiting

Update Subscriber API Endpoint

Example Request

Update Subscriber

Rate Limiting

Get Subscriber API Endpoint

Example Request

Get Subscriber

Rate Limiting

Delete Subscriber API Endpoint

Example Request

Delete Subscriber

Rate Limiting