Campaigns

• Get Campaign GET /campaigns/{campaignId}

• List Campaigns GET /campaigns

• Get Campaign Analytics GET /campaigns/{campaignId}/analytics

• List Campaign Options GET /campaigns/options

• List Campaign Messages GET /campaigns/{campaignId}/messages

Get Campaign

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

campaignIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/campaigns/{campaignId}

HTTPcURLJavaScriptPython

GET /v3/campaigns/{campaignId} 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",
    "description": "text",
    "lastMessageActivity": "2026-01-12T16:57:34.219Z",
    "deliveredCount": 1,
    "unsubscribeCount": 1,
    "responseCount": 1,
    "clickCount": 1,
    "clickRate": 1,
    "conversionCount": 1,
    "conversionRevenue": 1
  }
}

List Campaigns

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumberOptional

pageSizenumberOptional

sortBystringOptional

sortDirectionstring · enumOptionalPossible values:

querystringOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/campaigns

HTTPcURLJavaScriptPython

GET /v3/campaigns 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",
        "description": "text",
        "lastMessageActivity": "2026-01-12T16:57:34.219Z",
        "deliveredCount": 1,
        "unsubscribeCount": 1,
        "responseCount": 1,
        "clickCount": 1,
        "clickRate": 1,
        "conversionCount": 1,
        "conversionRevenue": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Get Campaign Analytics

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

campaignIdstringRequired

Query parameters

startDatestringRequired

endDatestringRequired

intervalstring · enumRequiredPossible values:

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/campaigns/{campaignId}/analytics

HTTPcURLJavaScriptPython

GET /v3/campaigns/{campaignId}/analytics?startDate=text&endDate=text&interval=days 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",
    "description": "text",
    "isArchived": true,
    "linkRecipientCount": 1,
    "timespanAnalytics": [
      {
        "ANY_ADDITIONAL_PROPERTY": {
          "deliveredCount": 1,
          "clickCount": 1,
          "spend": 1,
          "replyCount": 1,
          "unsubscribeCount": 1,
          "creditCount": 1,
          "conversionCount": 1
        }
      }
    ]
  }
}

List Campaign Options

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumberOptional

pageSizenumberOptional

sortBystringOptional

sortDirectionstring · enumOptionalPossible values:

querystringOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/campaigns/options

HTTPcURLJavaScriptPython

GET /v3/campaigns/options 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"
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

List Campaign Messages

get

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

campaignIdstringRequired

Query parameters

pagenumberOptional

pageSizenumberOptional

sortBystringOptional

sortDirectionstring · enumOptionalPossible values:

querystringOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get

/campaigns/{campaignId}/messages

HTTPcURLJavaScriptPython

GET /v3/campaigns/{campaignId}/messages 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,
        "isMMS": true,
        "message": "text",
        "createdAt": "text",
        "recipientCount": 1,
        "processedCount": 1,
        "emailRecipientCount": 1,
        "deliveredCount": 1,
        "unsubscribeCount": 1,
        "responseCount": 1,
        "clickCount": 1,
        "clickRate": 1,
        "conversionCount": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}