Threads

Thread Items

Get Thread

get
Authorizations
Path parameters
threadIdstringRequired
Responses
200

Success

application/json
Responseall of
get
GET /v3/threads/{threadId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "allSubscribers": true,
    "groups": [
      1
    ],
    "subscribers": [
      1
    ]
  }
}

Delete Thread

delete
Authorizations
Path parameters
threadIdstringRequired
Responses
200

Success

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

List Threads

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

Success

application/json
Responseall of
get
GET /v3/threads 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",
        "unread": true,
        "latestMessage": {
          "message": "text",
          "timestamp": "text"
        },
        "multipleRecipients": true
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Mark Thread as Read

patch
Authorizations
Path parameters
threadIdstringRequired
Responses
200

Success

application/json
patch
PATCH /v3/threads/{threadId}/read HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

Get Thread Items

get
Authorizations
Path parameters
threadIdstringRequired
Query parameters
pagenumberRequired
pageSizenumberRequired
getScheduledbooleanRequired
Responses
200

Success

application/json
Responseall of
get
GET /v3/threads/{threadId}/items?page=1&pageSize=1&getScheduled=true HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "accountId": 1,
    "name": "text",
    "items": [
      {
        "id": 1,
        "timestamp": "text",
        "message": 1,
        "inbound": 1,
        "table": 1,
        "scheduled": true,
        "users": 1,
        "replyFrom": 1,
        "url": 1
      }
    ],
    "count": 1,
    "multipleRecipients": true,
    "recentReply": {
      "name": "text",
      "number": "text"
    }
  }
}

Delete Thread Item

delete
Authorizations
Path parameters
threadIdstringRequired
Responses
200

Success

application/json
delete
DELETE /v3/threads/{threadId}/items 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?