Create Free API Account

Unsubscribes

Create Unsubscribe

post
Authorizations
Body
numberstringRequired
Responses
200

Success

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

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

Get Unsubscribe for Number

get
Authorizations
Path parameters
numberstringRequired
Responses
200

Success

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

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

List Unsubscribes

get
Authorizations
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200

Success

application/json
Responseall of
get
GET /v3/unsubscribes 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,
        "name": "text",
        "number": "text",
        "email": "text",
        "date": "2025-10-13T21:09:27.068Z"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Bulk Unsubscribes

post

This endpoint allows users to unsubscribe subscribers in bulk. The endpoint would accept array of objects with key "number", which is the phone number of the subscriber to unsubscribe and of type string.

undefined

Authorizations
Bodyobject[]
numberstringRequired
Responses
200

Success

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

[
  {
    "number": "text"
  }
]
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "totalRecordCount": 1,
    "unsubscribedRecordCount": 1,
    "errorRecordCount": 1,
    "unsubscribedRecords": [
      {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "email": "text",
        "number": 1,
        "e164Number": "text",
        "date": "2025-10-13T21:09:27.068Z",
        "countryId": 1,
        "groups": [
          {
            "id": 1,
            "name": "text",
            "addedToGroupAt": "2025-10-13T21:09:27.068Z"
          }
        ],
        "subscriberFieldData": [
          {
            "id": 1,
            "subscriberFieldId": 1,
            "data": "text"
          }
        ],
        "signupMethod": 1,
        "longNumber": 1,
        "carrierId": 1
      }
    ],
    "errorRecords": [
      {
        "number": "text",
        "error": "text"
      }
    ]
  }
}
PreviousThreadsNextVerify

Last updated

Was this helpful?