Scheduled Messages

Scheduled Messages Management

Get Scheduled Message

get
Authorizations
Path parameters
scheduledMessageIdstringRequired
Responses
200

Success

application/json
Responseall of
get
GET /v3/scheduled/{scheduledMessageId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "accountId": 1,
    "numberIds": [
      "text"
    ],
    "subscriberIds": [
      1
    ],
    "groupIds": [
      "text"
    ],
    "allSubscribers": 1,
    "message": "text",
    "url": "text",
    "scheduledDate": "2025-10-13T21:09:27.815Z",
    "timestamp": "2025-10-13T21:09:27.815Z",
    "repeatMessage": 1,
    "repeatDays": [
      1
    ],
    "repeatMonthType": "text",
    "excludedGroupIds": [
      "text"
    ],
    "header": "text",
    "footer": "text",
    "threadId": 1,
    "filterClicks": 1,
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "recipients": "text",
    "isMMS": true,
    "longcodeId": 1,
    "longcode": 1,
    "userId": 1,
    "userDescription": "text",
    "customRepeatFrequencyType": 1,
    "customRepeatFrequency": 1,
    "customRepeatDays": [
      1
    ],
    "customEndMessageType": 1,
    "customEndMessageDate": "text",
    "customEndMessageOccurrences": 1
  }
}

Update Scheduled Message

patch
Authorizations
Path parameters
scheduledMessageIdstringRequired
Body
messagestringOptional
numberIdsnumber[]Optional
groupIdsnumber[]Optional
allSubscribersbooleanOptional
scheduledDatestringOptional
imagestring | nullableOptional
repeatMessagenumberOptional
repeatDaysnumber[]Optional
repeatMonthTypestring | nullableOptional
excludedGroupIdsnumber[]Optional
headerstringOptional
footerstringOptional
isMMSbooleanOptional
repeatall ofOptional
and
templateIdnumberOptional
longcodeIdnumberOptional
customRepeatFrequencyTypenumber | nullableOptional
customRepeatFrequencynumber | nullableOptional
customRepeatDaysnumber[]Optional
customEndMessageTypenumber | nullableOptional
customEndMessageDatestring | nullableOptional
customEndMessageOccurrencesnumber | nullableOptional
Responses
200

Success

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

{
  "message": "text",
  "numberIds": [
    1
  ],
  "groupIds": [
    1
  ],
  "allSubscribers": true,
  "scheduledDate": "text",
  "image": "text",
  "repeatMessage": 1,
  "repeatDays": [
    1
  ],
  "repeatMonthType": "text",
  "excludedGroupIds": [
    1
  ],
  "header": "text",
  "footer": "text",
  "isMMS": true,
  "repeat": {
    "monday": true,
    "tuesday": true,
    "wednesday": true,
    "thursday": true,
    "friday": true,
    "saturday": true,
    "sunday": true,
    "type": "week",
    "frequency": -1,
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "templateId": 1,
  "longcodeId": 1,
  "customRepeatFrequencyType": 1,
  "customRepeatFrequency": 1,
  "customRepeatDays": [
    1
  ],
  "customEndMessageType": 1,
  "customEndMessageDate": "text",
  "customEndMessageOccurrences": 1
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "accountId": 1,
    "numberIds": [
      "text"
    ],
    "subscriberIds": [
      1
    ],
    "groupIds": [
      "text"
    ],
    "allSubscribers": 1,
    "message": "text",
    "url": "text",
    "scheduledDate": "2025-10-13T21:09:27.815Z",
    "timestamp": "2025-10-13T21:09:27.815Z",
    "repeatMessage": 1,
    "repeatDays": [
      1
    ],
    "repeatMonthType": "text",
    "excludedGroupIds": [
      "text"
    ],
    "header": "text",
    "footer": "text",
    "threadId": 1,
    "filterClicks": 1,
    "properties": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    },
    "recipients": "text",
    "isMMS": true,
    "longcodeId": 1,
    "longcode": 1,
    "userId": 1,
    "userDescription": "text",
    "customRepeatFrequencyType": 1,
    "customRepeatFrequency": 1,
    "customRepeatDays": [
      1
    ],
    "customEndMessageType": 1,
    "customEndMessageDate": "text",
    "customEndMessageOccurrences": 1
  }
}

Delete Scheduled Message

post
Authorizations
Path parameters
scheduledMessageIdstringRequired
Body
isMMSbooleanOptional
skippedAtone ofOptional
string · date-timeOptional
or
stringOptional
Responses
200

Success

application/json
post
POST /v3/scheduled/{scheduledMessageId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "isMMS": true,
  "skippedAt": "2025-10-13T21:09:27.815Z"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

List Scheduled Messages

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

Success

application/json
Responseall of
get
GET /v3/scheduled 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,
        "accountId": 1,
        "numberIds": [
          "text"
        ],
        "subscriberIds": [
          1
        ],
        "groupIds": [
          "text"
        ],
        "allSubscribers": 1,
        "message": "text",
        "url": "text",
        "scheduledDate": "2025-10-13T21:09:27.815Z",
        "timestamp": "2025-10-13T21:09:27.815Z",
        "repeatMessage": 1,
        "repeatDays": [
          1
        ],
        "repeatMonthType": "text",
        "excludedGroupIds": [
          "text"
        ],
        "header": "text",
        "footer": "text",
        "threadId": 1,
        "filterClicks": 1,
        "properties": {
          "ANY_ADDITIONAL_PROPERTY": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          }
        },
        "recipients": "text",
        "isMMS": true,
        "longcodeId": 1,
        "longcode": 1,
        "userId": 1,
        "userDescription": "text",
        "customRepeatFrequencyType": 1,
        "customRepeatFrequency": 1,
        "customRepeatDays": [
          1
        ],
        "customEndMessageType": 1,
        "customEndMessageDate": "text",
        "customEndMessageOccurrences": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Get Scheduled Message Calendar

get
Authorizations
Path parameters
yearstringRequired
monthstringRequired
Query parameters
querystringOptional
Responses
200

Success

application/json
Responseall of
get
GET /v3/scheduled/calendar/{year}/{month} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": [
    {
      "day": "text",
      "messages": [
        {
          "id": 1,
          "accountId": 1,
          "numberIds": [
            "text"
          ],
          "subscriberIds": [
            1
          ],
          "groupIds": [
            "text"
          ],
          "allSubscribers": 1,
          "message": "text",
          "url": "text",
          "scheduledDate": "2025-10-13T21:09:27.815Z",
          "timestamp": "2025-10-13T21:09:27.815Z",
          "repeatMessage": 1,
          "repeatDays": [
            1
          ],
          "repeatMonthType": "text",
          "excludedGroupIds": [
            "text"
          ],
          "header": "text",
          "footer": "text",
          "threadId": 1,
          "filterClicks": 1,
          "properties": {
            "ANY_ADDITIONAL_PROPERTY": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          },
          "recipients": "text",
          "isMMS": true,
          "longcodeId": 1,
          "longcode": 1,
          "userId": 1,
          "userDescription": "text",
          "customRepeatFrequencyType": 1,
          "customRepeatFrequency": 1,
          "customRepeatDays": [
            1
          ],
          "customEndMessageType": 1,
          "customEndMessageDate": "text",
          "customEndMessageOccurrences": 1
        }
      ]
    }
  ]
}

Get Scheduled Message Recipients

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

Success

application/json
Responseall of
get
GET /v3/scheduled/{scheduledMessageId}/recipients 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",
        "number": "text",
        "email": "text",
        "groupName": "text",
        "memberCount": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Delete Scheduled Messages for Number

delete
Authorizations
Path parameters
numberstringRequired
Responses
200

Success

application/json
delete
DELETE /v3/scheduled/number/{number} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

Last updated

Was this helpful?