Create Free API Account

Chatbots

Create Chatbot

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
namestringRequired
descriptionstring | nullableOptional
instructionsstringRequired
longcodeIdnumberRequired
filesstring[]Optional
isEnabledbooleanOptional
Responses
200

Success

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

{
  "name": "text",
  "description": "text",
  "instructions": "text",
  "longcodeId": 1,
  "files": [
    "text"
  ],
  "isEnabled": true
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "instructions": "text",
    "longcodeId": 1,
    "isEnabled": 1,
    "createdAt": "2025-11-28T01:11:18.912Z",
    "conversationCount": 1,
    "files": [
      {
        "id": 1,
        "filePath": "text",
        "url": "text"
      }
    ]
  }
}

Get Chatbot

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
chatbotIdstringRequired
Responses
200

Success

application/json
Responseall of
get
/chatbots/{chatbotId}
GET /v3/chatbots/{chatbotId} 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",
    "instructions": "text",
    "longcodeId": 1,
    "isEnabled": 1,
    "createdAt": "2025-11-28T01:11:18.912Z",
    "conversationCount": 1,
    "files": [
      {
        "id": 1,
        "filePath": "text",
        "url": "text"
      }
    ]
  }
}

Update Chatbot

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
chatbotIdstringRequired
Body
namestringOptional
descriptionstring | nullableOptional
instructionsstringOptional
filesstring[]Optional
isEnabledbooleanOptional
Responses
200

Success

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

{
  "name": "text",
  "description": "text",
  "instructions": "text",
  "files": [
    "text"
  ],
  "isEnabled": true
}
{
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "description": "text",
    "instructions": "text",
    "longcodeId": 1,
    "isEnabled": 1,
    "createdAt": "2025-11-28T01:11:18.912Z",
    "conversationCount": 1,
    "files": [
      {
        "id": 1,
        "filePath": "text",
        "url": "text"
      }
    ]
  }
}

List Chatbots

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
pagenumberOptional
pageSizenumberOptional
sortBystringOptional
sortDirectionstring · enumOptionalPossible values:
querystringOptional
Responses
200

Success

application/json
Responseall of
get
/chatbots
GET /v3/chatbots 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",
        "instructions": "text",
        "longcodeId": 1,
        "isEnabled": 1,
        "createdAt": "2025-11-28T01:11:18.912Z",
        "conversationCount": 1,
        "files": [
          {
            "id": 1,
            "filePath": "text",
            "url": "text"
          }
        ]
      }
    ],
    "page": 1,
    "pageSize": 1,
    "total": 1
  }
}
PreviousCampaignsNextControlled Templates

Last updated

Was this helpful?