The Mobile Text Alerts API allows Mobile Text Alerts customer to access their account data via HTTPS requests in order to retrieve subscriber information, send messages, and configure advanced features such as smart replies. Version 8 extends and improves upon version 7 by adopting modern REST API best practices and adding endpoints to Create, Read, Update, and Delete addition entities in the MTA ecosystem.
\nAll protected endpoints use Bearer Token authentication. In order to access these endpoints, the request must include an Authorization header with a value of Bearer myAPIKey where myaAPIKey is the unique access token assigned to your Mobile Text Alerts account.
If your account is configured for template-only message sending, please use the Controlled Template endpoints to view available templates. When sending or scheduling a message, the send endpoint will compose the message body using the provided templateId for a controlled template and, if required by the template, a provided linkId. Links can be created using the Create Short Link endpoint.
All API endpoints have a general rate limit of 30 requests per minute per IP address. Your rate limit usage can be tracked in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers.
Individual endpoints may override the general rate limit. Some of these endpoints may also use account based rate limiting where the rate limit is determined by the authenticated accounts instead of the IP. This is documented on the individual endpoints.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Template-Only Sending","slug":"template-only-sending"},{"content":"Rate Limiting","slug":"rate-limiting"}],"owner":"14373903","collectionId":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","publishedId":"UVR5q9DU","public":true,"customColor":{"top-bar":"0D4534","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-08-29T18:49:34.000Z"},"item":[{"name":"Account Variables","item":[{"name":"List Account Variables","id":"48b6434c-239e-44f8-96a8-16abf7951005","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/account-variables","description":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
ID or Title
\n","type":"text/plain"},"type":"any","value":"test2","key":"idOrTitle"}]}},"response":[{"id":"5132a29e-594e-4fe5-884c-f288882d0f78","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"value\": \"example2\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/account-variables/:idOrTitle","host":["{{url}}"],"path":["account-variables",":idOrTitle"],"variable":[{"key":"idOrTitle","value":"test","description":"ID or Title"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"X-Request-ID","value":"6558ae52-a282-49d6-a934-1a10c771c803"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"105"},{"key":"ETag","value":"W/\"69-jH/jiLuV3msUpadNcFYV+tQ/qqs\""},{"key":"Date","value":"Thu, 14 Oct 2021 17:17:51 GMT"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": 1,\n \"title\": \"test\",\n \"value\": \"example2\",\n \"createdAt\": \"2022-10-05T13:01:59.000Z\",\n \"updatedAt\": \"2022-10-05T05:00:00.000Z\"\n }\n}"}],"_postman_id":"27556ca5-7aed-4b0b-ad31-d57ef8fa97bd"},{"name":"Delete Account Variable","id":"777cfb87-56fa-41a9-b1be-15f5b500cb32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{url}}/account-variables/:idOrTitle","description":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
ID or Title
\n","type":"text/plain"},"type":"any","value":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
ID or Title
\n","type":"text/plain"},"type":"any","value":"Id of Controlled Template to retrieve.
\n","type":"text/plain"},"type":"any","value":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
Id of the custom field to update
\n","type":"text/plain"},"type":"any","value":"Id of custom field to delete
\n","type":"text/plain"},"type":"any","value":"Id or name of custom field to retrieve
\n","type":"text/plain"},"type":"any","value":"This feature is currently in closed beta. Please contact your MTA account rep or MTA support for more information.
\nandroidURI: The deeplink URI for Android.iosURI: The deeplink URI for iOS.macURI: The deeplink URI for Mac.windowsURI: The deeplink URI for Windows.defaultURI: The default deeplink URI.Upon successful creation, the response will include the deeplinkUrl
Request:
\n{\n \"androidURI\": \"sms:+15555555555?body=Example\",\n \"iosURI\": \"imessage://imessage@example.com?body=Example\",\n \"macURI\": \"https://mobile-text-alerts.com/example\",\n \"windowsURI\": \"https://mobile-text-alerts.com/example\",\n \"defaultURI\": \"https://mobile-text-alerts.com/example\"\n}\n\nResponse:
\n{\n \"deeplinkUrl\": \"https://platform.mobile-text-alerts.com/deeplinks/abc\"\n}\n\nThis feature is currently in closed beta. Please contact your MTA account rep or MTA support for more information.
\nlongcodeId: The id of the longcode.optInMessage: The opt-in message used to populate the deeplink urls.senderName: The sender name used to pre-populate the \"To:\" field for iMessageUpon successful creation, the response will include the deeplinkUrl
Request:
\n{\n \"longcodeId\": 1337,\n \"optInMessage\": \"Example\",\n \"senderName\": \"example@i-msg.co\"\n}\n\nResponse:
\n{\n \"deeplinkUrl\": \"https://platform.mobile-text-alerts.com/deeplinks/abc\"\n}\n\nList all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.
Specific page number to retrieve
\n","type":"text/plain"},"key":"page","value":"Number of results per page
\n","type":"text/plain"},"key":"pageSize","value":"Field to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"Direction to sort results by
\n","type":"text/plain"},"key":"sortDirection","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Field to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"Direction to sort results by
\n","type":"text/plain"},"key":"sortDirection","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Message Id
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"7a897d43-4580-484e-ade8-1ca62cc21119","name":"Success","originalRequest":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\": \"Drip Start 1\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/drip-campaigns/:campaignId/messages/:messageId","host":["{{url}}"],"path":["drip-campaigns",":campaignId","messages",":messageId"],"variable":[{"key":"campaignId","value":"12345"},{"key":"messageId","value":"11111"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Updated drip campaign message 11111.\",\n \"data\": {\n \"id\": 11111,\n \"accountId\": 123456,\n \"title\": \"Start\",\n \"content\": \"Drip Start 1\",\n \"attachment\": null,\n \"added\": {\n \"val\": \"CURRENT_TIMESTAMP\"\n },\n \"sequence\": 0,\n \"delay\": \"0\",\n \"timeOfDay\": \"00:00:00\",\n \"dripCampaignId\": 12345,\n \"isMms\": 0\n }\n}"}],"_postman_id":"8907d819-31c5-4561-a019-4fcf14f22673"},{"name":"Delete Drip Campaign Message","id":"ed8d5280-5841-4d02-97f7-d00a9c31a154","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{url}}/drip-campaigns/:campaignId/messages/:messageId","auth":{"type":"bearer","bearer":{"token":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","name":"Mobile Text Alerts API - v8","type":"collection"}},"urlObject":{"path":["drip-campaigns",":campaignId","messages",":messageId"],"host":["{{url}}"],"query":[],"variable":[{"id":"42a559ff-192e-43ea-9edc-c7b160c8db0c","description":{"content":"Campaign Id
\n","type":"text/plain"},"type":"any","value":"Message Id
\n","type":"text/plain"},"type":"any","value":null,"key":"messageId"}]}},"response":[{"id":"a5c233f8-6bef-4c24-98ee-94a5a9982afc","name":"Success","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\r\n \"content\": \"Drip Start 1\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{url}}/drip-campaigns/:campaignId/messages","host":["{{url}}"],"path":["drip-campaigns",":campaignId","messages"],"variable":[{"key":"campaignId","value":"12345"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Deleted drip campaign message 11111.\"\n}"}],"_postman_id":"ed8d5280-5841-4d02-97f7-d00a9c31a154"}],"id":"07816129-e64f-4353-ab19-895aa70d00f9","_postman_id":"07816129-e64f-4353-ab19-895aa70d00f9","description":"","auth":{"type":"bearer","bearer":{"token":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","name":"Mobile Text Alerts API - v8","type":"collection"}}},{"name":"Groups","item":[{"name":"Create Group","id":"8b430cb5-db5d-44b3-9828-2cf81a80d178","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"name\": \"Required fields: name
Id of group to delete
\n","type":"text/plain"},"type":"any","value":"Required Fields: subscriberId
Note: Field addToDripCampaigns is true by default.
Id of group to add subscriber to
\n","type":"text/plain"},"type":"any","value":"Id of group to delete subscriber from
\n","type":"text/plain"},"type":"any","value":"Id of subscriber to be deleted
\n","type":"text/plain"},"type":"any","value":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 5 requests per 15 seconds.
This endpoint will accept a maximum of 1,000 records in a single request.
Group Id
\n","type":"text/plain"},"type":"any","value":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 5 requests per 15 seconds.
This endpoint will accept a maximum of 1,000 records in a single request.
Group Id
\n","type":"text/plain"},"type":"any","value":"List all subscribers.
\n","auth":{"type":"bearer","bearer":{"token":"{{apiKey}}"},"isInherited":true,"source":{"_postman_id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","id":"9f3b1ef2-b2af-4fe5-b59b-42f5c2a4cd7f","name":"Mobile Text Alerts API - v8","type":"collection"}},"urlObject":{"path":["keywords"],"host":["{{url}}"],"query":[{"disabled":true,"description":{"content":"Specific page number to retrieve
\n","type":"text/plain"},"key":"page","value":"Number of results per page
\n","type":"text/plain"},"key":"pageSize","value":"Field to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"Direction to sort results by
\n","type":"text/plain"},"key":"sortDirection","value":"Query to search by
\n","type":"text/plain"},"key":"query","value":"Id of keyword to retrieve
\n","type":"text/plain"},"type":"any","value":"Id of scheduled message to delete
\n","type":"text/plain"},"type":"any","value":"Id of scheduled message to retrieve
\n","type":"text/plain"},"type":"any","value":"Id of scheduled message to update
\n","type":"text/plain"},"type":"any","value":"message: string
image: string
An attachment for the message in the form of a URL.
\nSee Send as MMS for more details.
\nrehost: boolean
An indicator to specify if the attached image should be rehosted by MTA before being sent.
\nSee Send as MMS for more details.
\ngated: boolean
A control flag to indicate to Mobile Text Alerts that this message should be sent as a Gated Message. You must have Gated Messaging enabled on your account for this flag to have any effect.
\nIf this flag is omitted or explicitly set to false, the message will be sent through the standard messaging routes. If set to true the message will pass through the Gated Message system before sending.
templateId: number
linkId: number
templateId and the template includes a link, this field is used to find the correspinding link.subscriberIds: number[]
subscribers: (number | string)[]
allSubscribers: boolean
An indicator to send the message to all subscribers if true.
\nDefault: false.
groups: number[]
threadId: number
isMMS: boolean
An indicator to send the message as MMS instead of SMS.
\nDefault behavior: False for messages without an attachment. True for messages with an attachment.
\nSee Send as MMS for more details.
\nheader: string
footer: string
longcodeId: number
senderName: string
externalId: string
externalId will be included in webhook notifications.properties: { [key: string]: string }
Properties are used to populate the liquid template variables in your message.
\nSee Using Properties for details.
\nscheduledDate: string
The date and time a message should be scheduled to send.
\nMust be in ISO8601 format (eg. \"20230302T173000-0500\").
\nrepeat: IRepeat
If a scheduled message should go out repeatedly, repeat indicates how.
Default behavior: If repeat is not provided, the scheduled message will not repeat.
interface IRepeat { monday: boolean; tuesday: boolean; wednesday: boolean; thursday: boolean; friday: boolean; saturday: boolean; sunday: boolean;, type: \"week\" | \"month\"; frequency: RepeatFrequency; }\n \n enum RepeatFrequency { NEVER = 0, DAILY = 1, WEEKLY = 2, BIWEEKLY = 3, MONTHLY = 4, ANNUALLY = 5 }\n \ntags
Content to Send: One of the following
\nmessage
image
templateId
Recipients: One of the following
\nsubscriberIds
subscribers
allSubscribers
groups
threadId
If templateId is used and corresponds to a template that requires a link, linkId is required.
The subscribers field is a list of recipient phone numbers or email addresses. If a provided recipient is not already a subscriber on your account, one will be created.
Messages will be sent to a subscriber's phone number if one is set, otherwise, the message will be sent to the subscriber via email.
\nThe allSubscribers request field can be set to true in order to send the message to all subscribers. When allSubscribers is set to true, no other recipient fields should be specified.
A message with an attachment (image) will be sent as MMS by default. A messages without an attachment will be sent as SMS by default. A message without an attachment can be sent as MMS by setting the isMMS request field to true.
If the rehost flag is provided and is set to true, the attachment will be rehosted on an MTA server before being sent to the recipients. You may prefer to do this in the event that the recipient isn't receiving your attachment or you simply don't want to host the attachment yourself.
Gated Messaging is a service provided by Mobile Text Alerts that provides an additional layer of identity verification prior to displaying your message content. Your account must be explicitly enabled for Gated Messaging by your Account Manager or Customer Support Agent. Once enabled, you can use the gated boolean flag to indicate whether a given message send should use the Gated Messaging route or your standard messaging routes.
SMS messages cost 1 credit per 160 characters
\nMMS messages cost 3 credits
\nAccounts configured for template-only sending should provide a templateId rather than a message.
If the template corresponding to templateId requires a link, a linkId should also be provided.
All available controlled templates can be queried via the Controlled Template endpoints.
\nLinks can be created using the Create Short Link endpoint.
\nBy inserting one or more Liquid Template variables into your message and using the properties field, you can send a unique message to each subscriber with a single API call.
The properties field is a map between the individual subscribers you're sending your message to, and the values of the variables in your message.
Example:
\n{\n \"subscribers\": [\"3175551111\", \"3175552222\"],\n \"message\": \"Hello {{firstName}}! Visit {{link}}\",\n \"properties\": {\n \"3175551111\": {\n \"firstName\": \"Bob\",\n \"link\": \"https://example.com/abc\"\n },\n \"3175552222\": {\n \"firstName\": \"Tony\",\n \"link\": \"https://example.com/def\"\n }\n }\n}\n\nThe send endpoint is idempotent which means that it handles de-duplicating requests in the event of networking issues or other issues that might cause a request to be in an unknown state.
\nWhen sending your request to the endpoint, simply include an X-Request-Id header with an alphanumeric value. If you're unsure if the request succeeded or not, you can simply re-send the request with the same X-Request-Id and the send endpoint will detect if it's a duplicate or not.
If the request is a duplicate, you'll receive a 409 Conflict error response.
from: stringto: stringmessage: stringisMMS: booleanfee: number
carrierFee: number
totalCost: number
messageCredits: number
premiumCredits: number
messageCount: number
message field can be excluded or left blank to indicate that, when isMMS is true, that the message would be an attachment only.isMMS field can be excluded and will default to false.Id of Smart Reply to delete
\n","type":"text/plain"},"type":"any","value":"Id of Smart Reply to retrieve
\n","type":"text/plain"},"type":"any","value":"Id of Smart Reply to update
\n","type":"text/plain"},"type":"any","value":"Add a new subscriber. If given a phone number or email that already exists tied to the same account, updates the existing subscriber with new information
\nRequired Fields: email or number
\nThis endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
Remove a subscriber. Doesn't check for invalid IDs (returns success but doesn't delete anything for an invalid subscriber ID).
\nThis endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
Subscriber Id or Phone Number
\n","type":"text/plain"},"type":"any","value":"This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
Subscriber Id Or Phone Number
\n","type":"text/plain"},"type":"any","value":"List all subscribers and query for subscribers. Includes all subscribers with query value in either first name, last name, number, email, or custom subscriber fields and with filters values in respective categories.
This endpoint overrides the general rate limit with an account rate limit. Requests are limited by the authenticated account instead of the IP address. This endpoint is limited to 15 requests per 15 seconds.
Specific page number to retrieve
\n","type":"text/plain"},"key":"page","value":"Number of results per page
\n","type":"text/plain"},"key":"pageSize","value":"Field to sort results by
\n","type":"text/plain"},"key":"sortBy","value":"Direction to sort results by
\n","type":"text/plain"},"key":"sortDirection","value":"