Groups

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

Create Group POST /groups
Get Group GET /groups/{groupId}
Update Group PATCH /groups/{groupId}
Delete Group DELETE /groups/{groupId}
List Groups GET /groups

Group Member Management

Add Subscriber to Group POST /groups/{groupId}/subscribers
Delete Subscriber from Group DELETE /groups/{groupId}/subscribers/{subscriberId}

Group Member Counts

List All Groups and Member Count GET /groups/member-count/all
Get Adaptive Group Member Count GET /groups/{groupId}/member-count

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

Create Group

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestringRequired

hiddennumberOptional

displayNamestringOptional

sortOrdernumberOptional

descriptionstringOptional

isTemporarybooleanOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post/groups

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

{
  "name": "text",
  "hidden": 1,
  "displayName": "text",
  "sortOrder": 1,
  "description": "text",
  "isTemporary": true
}

{
  "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": "2026-07-10T04:57:44.098Z",
    "memberCount": 1
  }
}

Get Group

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get/groups/{groupId}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

Body

namestringRequired

hiddennumberOptional

displayNamestringOptional

sortOrdernumberOptional

descriptionstringOptional

isTemporarybooleanOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

patch/groups/{groupId}

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: 101

{
  "name": "text",
  "hidden": 1,
  "displayName": "text",
  "sortOrder": 1,
  "description": "text",
  "isTemporary": true
}

{
  "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": "2026-07-10T04:57:44.098Z",
    "memberCount": 1
  }
}

Delete Group

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

delete/groups/{groupId}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumberOptional

pageSizenumberOptional

sortDirectionstring · enumOptionalPossible values:

querystringOptional

sortBystringOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get/groups

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": "2026-07-10T04:57:44.098Z",
        "memberCount": 1
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}

Add Subscriber to Group

post

Required Fields: subscriberId

Note: Field addToDripCampaigns is true by default.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

Body

subscriberIdnumberRequired

addToDripCampaignsbooleanOptional

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

post/groups/{groupId}/subscribers

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

subscriberIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

delete/groups/{groupId}/subscribers/{subscriberId}

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

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pagenumberOptional

pageSizenumberOptional

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/groups/member-count/all

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": "2026-07-10T04:57:44.098Z",
        "memberCount": 1
      }
    ]
  }
}

Get Adaptive Group Member Count

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

groupIdstringRequired

Responses

200

Success

application/json

400

BadRequestError

application/json

401

UnauthorizedError

application/json

403

ForbiddenError

application/json

500

InternalServerError

application/json

get/groups/{groupId}/member-count

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 Campaigns NextBulk Group Actions

Last updated 9 months ago

Was this helpful?