For the complete documentation index, see llms.txt. This page is also available as Markdown.

Bulk Subscriber Actions

For more information on how to use these endpoints see: Bulk Create/Update Subscribers

Bulk Create Subscribers

post

Record Limit

This endpoint will accept a maximum of 1,000 records in a single request. Records of subscribers should be in an array. The createOnly field indicates if the action is creating new subscribers only (doesn't accept records of existing subscribers) or the action is creating or updating (accept records of existing subscribers and update info according to the records).

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>.
Query parameters
createOnlystringOptional
Bodyobject · INewNumber[]
firstNamestringOptional
lastNamestringOptional
emailstringOptional
numberone ofOptional
numberOptional
or
stringOptional
e164NumberstringOptional
groupIdsnumber[]Optional
employeeNumberstringOptional
welcomeMessagestringOptional
Responses
200

Success

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

[
  {
    "firstName": "text",
    "lastName": "text",
    "email": "text",
    "number": 1,
    "e164Number": "text",
    "groupIds": [
      1
    ],
    "subscriberFields": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "employeeNumber": "text",
    "welcomeMessage": "text"
  }
]
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "totalRecordCount": 1,
    "createdRecordCount": 1,
    "errorRecordCount": 1,
    "createdRecords": [
      {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "number": 1,
        "e164Number": "text",
        "date": "2026-01-01T00:00:00.000Z",
        "countryId": 1,
        "groups": [
          {
            "id": 1,
            "name": "text",
            "addedToGroupAt": "2026-01-01T00:00:00.000Z"
          }
        ],
        "subscriberFieldData": [
          {
            "id": 1,
            "subscriberFieldId": 1,
            "data": "text"
          }
        ],
        "signupMethod": 1,
        "longNumber": 1,
        "carrierId": 1
      }
    ],
    "errorRecords": [
      {
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "number": 1,
        "e164Number": "text",
        "groupIds": [
          1
        ],
        "subscriberFields": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "employeeNumber": "text",
        "welcomeMessage": "text",
        "error": "text"
      }
    ]
  }
}

Bulk Update Subscribers

patch

Record Limit

This endpoint will accept a maximum of 1,000 records in a single request.

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>.
Bodyone of[]
or
or
Responses
200

Success

application/json
patch/subscribers/bulk
PATCH /v3/subscribers/bulk HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 221

[
  {
    "record": {
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "number": 1,
      "e164Number": "text",
      "groupIds": [
        1
      ],
      "subscriberFields": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "employeeNumber": "text",
      "welcomeMessage": "text"
    },
    "id": 1
  }
]
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "totalRecordCount": 1,
    "updatedRecordCount": 1,
    "errorRecordCount": 1,
    "updatedRecords": [
      {
        "record": {
          "id": 1,
          "firstName": "text",
          "lastName": "text",
          "email": "text",
          "number": 1,
          "e164Number": "text",
          "date": "2026-01-01T00:00:00.000Z",
          "countryId": 1,
          "groups": [
            {
              "id": 1,
              "name": "text",
              "addedToGroupAt": "2026-01-01T00:00:00.000Z"
            }
          ],
          "subscriberFieldData": [
            {
              "id": 1,
              "subscriberFieldId": 1,
              "data": "text"
            }
          ],
          "signupMethod": 1,
          "longNumber": 1,
          "carrierId": 1
        },
        "id": 1
      }
    ],
    "errorRecords": [
      {
        "error": "text",
        "id": 1
      }
    ]
  }
}

Last updated

Was this helpful?