LogoLogo
Jump to...Create Free API Account
  • Developer Center Introduction
  • Getting Started
    • Get an API Key
    • Send a Message
    • Add a Subscriber
    • Setting up Webhooks
  • Check Delivery Status
  • API Basics
    • Request / Response Headers
    • Request Parameters
    • Rate Limits
    • Error Response Codes
  • Messaging Routes
    • 10DLC
    • Toll-Free
    • Short Code
    • iMessage
    • RCS / RBM
  • Tutorials
    • Message Sending
      • Send an SMS Message
      • Send an MMS Message
      • Send an iMessage
        • Sender Identity
        • Subscriber Opt In
        • Send iMessages
        • SMS Fallback
      • Message Templates
      • Receive and Reply to Messages
    • Manage Subscribers
      • Custom Subscriber Attributes
      • Group Subscribers
      • Bulk Create/Update Subscribers
    • Webhooks
      • Setting up your first webhook
  • Use Cases
    • Generate and validate 2FA / MFA codes via SMS
  • FAQ
  • API Reference
Powered by GitBook
LogoLogo

Resources

  • Help Center
  • Contact

Company

  • About Us
  • Privacy Policy
  • Service Agreement

Connect with Us

  • YouTube
  • Facebook
  • X (Twitter)
  • Instagram

Mobile Text Alerts © 2025

On this page

Was this helpful?

Export as PDF
  1. API Basics

Request Parameters

Learn the types of parameters used in a request to the Mobile Text Alerts API.

PreviousRequest / Response HeadersNextRate Limits

Last updated 2 months ago

Was this helpful?

Header Parameters

Header parameters are included in the request header, all requests to the Mobile Text Alerts API require a valid Authorization header. See to learn more.

Path Parameters

Path parameters (sometimes called path variables) are part of the endpoint itself and are not optional when making a request to certain endpoints.

For example, when calling the Update Drip Campaign endpoint:

https://api.mobile-text-alerts.com/v3/drip-campaigns/

The {dripCampaignId} is a string that identifies the id of the campaign to be updated.

Request Bodies

The request body contains the actual data being transferred. This is particularly important in methods such as POST, PATCH, and DELETE, where data is sent to the server. This data is typically sent as JSON.

For example, when calling the Update Drip Campaign endpoint, the name and endDate of a campaign can be updated in the request body:

{
    "name": "<string>",
    "endDate": "<YYYY-MM-DD HH:mm:ss>"
}

Example request to Update Drip Campaign endpoint:

curl --location --request PATCH 'https://api.mobile-text-alerts.com/v3/drip-campaigns/' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Example Campaign Name"
}'
Request Headers
  • Header Parameters
  • Path Parameters
  • Request Bodies
  • PATCHUpdate Drip Campaign

Update Drip Campaign

patch
Authorizations
Path parameters
dripCampaignIdstringRequired
Body
namestringOptional
endDatestringOptional
Responses
200
Success
application/json
Responseall of
400
BadRequestError
application/json
401
UnauthorizedError
application/json
403
ForbiddenError
application/json
500
InternalServerError
application/json
patch
PATCH /v3/drip-campaigns/{dripCampaignId} HTTP/1.1
Host: api.mobile-text-alerts.com
Authorization: Bearer apiKey
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "name": "text",
  "endDate": "text"
}
{
  "statusCode": "MTANoLinkedAccountError",
  "success": true,
  "error": "text",
  "message": "text",
  "data": {
    "id": 1,
    "name": "text",
    "endDate": "2025-06-08T13:00:57.439Z",
    "created": "2025-06-08T13:00:57.439Z",
    "groupIds": [
      1
    ],
    "campaignMessages": [
      {
        "id": 1,
        "accountId": 1,
        "title": "text",
        "content": "text",
        "attachment": "text",
        "added": "2025-06-08T13:00:57.439Z",
        "sequence": 1,
        "delay": 1,
        "timeOfDay": "text",
        "dripCampaignId": 1,
        "isMms": 1,
        "memberCount": 1,
        "memberNames": [
          "text"
        ]
      }
    ]
  }
}