Create Free API Account

Groups

For more information on how to use these endpoints see: Group Subscribers

Group Member Management

Group Member Counts

See Bulk Group Actions for large group changes in a single request.

Create Group

post
Authorizations
Body
idnumberOptional
accountIdnumberOptional
namestringOptional
hiddennumberOptional
keywordstringOptional
welcomeMessagestringOptional
descriptionstringOptional
parentWebinarIdstringOptional
displayNamestring | nullableOptional
sortOrdernumber | nullableOptional
typestring · enumOptionalPossible values:
isTemporarybooleanOptional
createdAtone ofOptional
string · date-timeOptional
or
stringOptional
or
string | nullableOptional
Responses
200

Success

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

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "hidden": 1,
  "keyword": "text",
  "welcomeMessage": "text",
  "description": "text",
  "parentWebinarId": "text",
  "displayName": "text",
  "sortOrder": 1,
  "type": "static",
  "settings": {
    "match": "AND",
    "conditions": [
      {
        "type": "text",
        "conditionAttribute": "text",
        "conditionOperator": "equals",
        "conditionCategory": "text",
        "conditionValue": [
          "text"
        ],
        "conditionSubOperator": "equals",
        "conditionSubValue": [
          "text"
        ],
        "shouldLoadDefaultValue": true
      }
    ]
  },
  "isTemporary": true,
  "createdAt": "2025-10-13T15:56:27.168Z"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "hidden": 1,
    "welcomeMessage": "text",
    "description": "text",
    "parentWebinarId": "text",
    "displayName": "text",
    "sortOrder": 1,
    "type": "static",
    "settings": {
      "match": "AND",
      "conditions": [
        {
          "type": "text",
          "conditionAttribute": "text",
          "conditionOperator": "equals",
          "conditionCategory": "text",
          "conditionValue": [
            "text"
          ],
          "conditionSubOperator": "equals",
          "conditionSubValue": [
            "text"
          ],
          "shouldLoadDefaultValue": true
        }
      ]
    },
    "isTemporary": true,
    "createdAt": "2025-10-13T15:56:27.168Z",
    "memberCount": 1
  }
}

Get Group

get
Authorizations
Path parameters
groupIdstringRequired
Responses
200

Success

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

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

Update Group

patch
Authorizations
Path parameters
groupIdstringRequired
Body
idnumberOptional
accountIdnumberOptional
namestringOptional
hiddennumberOptional
keywordstringOptional
welcomeMessagestringOptional
descriptionstringOptional
parentWebinarIdstringOptional
displayNamestring | nullableOptional
sortOrdernumber | nullableOptional
typestring · enumOptionalPossible values:
isTemporarybooleanOptional
createdAtone ofOptional
string · date-timeOptional
or
stringOptional
or
string | nullableOptional
Responses
200

Success

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

{
  "id": 1,
  "accountId": 1,
  "name": "text",
  "hidden": 1,
  "keyword": "text",
  "welcomeMessage": "text",
  "description": "text",
  "parentWebinarId": "text",
  "displayName": "text",
  "sortOrder": 1,
  "type": "static",
  "settings": {
    "match": "AND",
    "conditions": [
      {
        "type": "text",
        "conditionAttribute": "text",
        "conditionOperator": "equals",
        "conditionCategory": "text",
        "conditionValue": [
          "text"
        ],
        "conditionSubOperator": "equals",
        "conditionSubValue": [
          "text"
        ],
        "shouldLoadDefaultValue": true
      }
    ]
  },
  "isTemporary": true,
  "createdAt": "2025-10-13T15:56:27.168Z"
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "hidden": 1,
    "welcomeMessage": "text",
    "description": "text",
    "parentWebinarId": "text",
    "displayName": "text",
    "sortOrder": 1,
    "type": "static",
    "settings": {
      "match": "AND",
      "conditions": [
        {
          "type": "text",
          "conditionAttribute": "text",
          "conditionOperator": "equals",
          "conditionCategory": "text",
          "conditionValue": [
            "text"
          ],
          "conditionSubOperator": "equals",
          "conditionSubValue": [
            "text"
          ],
          "shouldLoadDefaultValue": true
        }
      ]
    },
    "isTemporary": true,
    "createdAt": "2025-10-13T15:56:27.168Z",
    "memberCount": 1
  }
}

Delete Group

delete
Authorizations
Path parameters
groupIdstringRequired
Responses
200

Success

application/json
delete
DELETE /v3/groups/{groupId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List Groups

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

Success

application/json
Responseall of
get
GET /v3/groups 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",
        "hidden": 1,
        "welcomeMessage": "text",
        "description": "text",
        "parentWebinarId": "text",
        "displayName": "text",
        "sortOrder": 1,
        "type": "static",
        "settings": {
          "match": "AND",
          "conditions": [
            {
              "type": "text",
              "conditionAttribute": "text",
              "conditionOperator": "equals",
              "conditionCategory": "text",
              "conditionValue": [
                "text"
              ],
              "conditionSubOperator": "equals",
              "conditionSubValue": [
                "text"
              ],
              "shouldLoadDefaultValue": true
            }
          ]
        },
        "isTemporary": true,
        "createdAt": "2025-10-13T15:56:27.168Z",
        "memberCount": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Add Subscriber to Group

post

Required Fields: subscriberId

Note: Field addToDripCampaigns is true by default.

undefined

Authorizations
Path parameters
groupIdstringRequired
Body
subscriberIdnumberRequired
addToDripCampaignsbooleanOptional
Responses
200

Success

application/json
post
POST /v3/groups/{groupId}/subscribers HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44

{
  "subscriberId": 1,
  "addToDripCampaigns": true
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": null
}

Remove Subscriber from Group

delete
Authorizations
Path parameters
groupIdstringRequired
subscriberIdstringRequired
Responses
200

Success

application/json
delete
DELETE /v3/groups/{groupId}/subscribers/{subscriberId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

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

List All Groups and Member Count

get
Authorizations
Query parameters
Responses
200

Success

application/json
Responseall of
get
GET /v3/groups/member-count/all 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",
        "hidden": 1,
        "welcomeMessage": "text",
        "description": "text",
        "parentWebinarId": "text",
        "displayName": "text",
        "sortOrder": 1,
        "type": "static",
        "settings": {
          "match": "AND",
          "conditions": [
            {
              "type": "text",
              "conditionAttribute": "text",
              "conditionOperator": "equals",
              "conditionCategory": "text",
              "conditionValue": [
                "text"
              ],
              "conditionSubOperator": "equals",
              "conditionSubValue": [
                "text"
              ],
              "shouldLoadDefaultValue": true
            }
          ]
        },
        "isTemporary": true,
        "createdAt": "2025-10-13T15:56:27.168Z",
        "memberCount": 1
      }
    ]
  }
}

Get Adaptive Group Member Count

get
Authorizations
Path parameters
groupIdstringRequired
Responses
200

Success

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

{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "memberCount": 1
  }
}
PreviousDrip CampaignsNextBulk Group Actions

Last updated

Was this helpful?