Generate an API Key

API Keys can be generated in the Mobile Text Alerts platform dashboard.

1. Visit for your account. This is under the three-dot menu in the top right of the platform dashboard.

2. Select the tab or scroll down to Developer Resources.

3. Click the GENERATE A NEW KEY button. Enter a name for the new API Key.

This API Key is used to make authenticated calls to the Mobile Text Alerts API.

Bearer Token Authentication

This API Key is used as a bearer token when making requests to the API. A bearer token is included in the request header to grant a user or application access to a protected endpoint.

Header structure: "Authorization: Bearer {myAPIKey}"

Example request to verify the API Key

Below is an example cURL request with a bearer token to the endpoint, this will verify the API Key as valid.

If valid, a response will be returned with the message: "API Key verified"

Welcome to the Mobile Text Alerts Developer Center

With the Mobile Text Alerts API you can take full control over your account with message sending, phone number segmentation and more. The API allows you to perform CRUD (create, read, update, delete) operations without incurring any additional costs, as API access comes bundled with every subscription.

2025

The MTA API allows you to view, add, edit, and remove subscribers from your account just like you can from the platform dashboard page. This page will guide you through adding a subscriber with the API.

Add a Subscriber with the Mobile Text Alerts API

Subscribers can be added via the API with a POST request to the /subscribers endpoint. A phone number (number) or email address (email) is required. If you add a phone number or email of a subscriber that already exists on the account, this will update the existing subscriber with any changes.

Example request to add a subscriber

Below is an example cURL POST request to the /subscribers endpoint to add a new subscriber.

To view all possible request parameters see:

Example Response

If valid, a response will be returned with the message: "Subscriber created successfully."

Send a message with the Mobile Text Alerts API

Messages are sent via the API with POST requests to the /send endpoint. The request data must contain both recipient and content information.

Required Fields: (Must be one of the following from each)

SDK Overview

What is an SDK?

An SDK (Software Development Kit) is a collection of tools, libraries, documentation, and code samples that developers can use to build applications for a specific platform, framework, or service. It provides a pre-packaged toolbox so developers don't need to worry about low-level implementation details and provides a higher-level interface for interacting with a system.

Once your subscribers begin , you're ready to send iMessages to them. Mobile Text Alerts will automatically capture and record the inbound opt-in messages and internally flag your subscribers as iMessage enabled and opted-in. Remember, opt-ins are tied to a specific Sender Identity, so you must receive inbound consent from a subscriber on each Sender Identity you plan to use to send messages to them.

Send iMessages via the API

When sending iMessages via API, you need to specify a Sender Identity and Mobile Text Alerts will handle routing messages intelligently based on current subscriber status. For the subscribers included in a /send call, the system will verify whether they are enabled for iMessage and then route messages through your Sender Identity. Graceful is also supported.

• Create Chatbot

• Get Chatbot

• Update Chatbot

• List Chatbots

What is an API?

API stands for Application Programming Interface. APIs enable communication between two software components, typically a client and a server. The application sending the request is the client, and the application sending the response is the server. When interacting with the Mobile Text Alerts API, the Mobile Text Alerts database is the server, and you send requests as the client.

There are different types of APIs, the MTA API is a REST API.

REST APIs

REST stands for Representational State Transfer, a REST API is a way for software systems to communicate using HTTP. The main principle of REST APIs is statelessness, which means each request from a client to a server must contain all the information needed (no session stored on the server). The server processes the request and returns the necessary data as plain text.

HTTP Methods in REST

HTTP methods indicate the action the client would like to perform on a given resource. Examples of possible actions when calling the Mobile Text Alerts API: send a message, add/delete a subscriber, create a drip campaign, and many more.

Each HTTP method is mapped to a specific operation and is included with every request to the API.

HTTP Methods:

• GET - Retrieves data from the server.

  • Example: A GET request to the /subscribers endpoint would return a list of all subscribers.

• POST - Sends data to the server to create something new.

REST API Responses

After making a request to the API, it will return a response that contains the following information:

• - This three-digit code indicates the outcome of the request

  • Example: 200

• - This provides metadata about the response.

HTTP Status Codes

Each request to the API will return an HTTP status code, a three-digit code that indicates the outcome of the request.

What is RCS messaging?

RCS stands for Rich Communication Services, which is a next-generation messaging protocol that upgrades traditional SMS/MMS by allowing more dynamic and secure conversations.

RCS Message Features

• Richer message content- RCS allows sending high-resolution images, videos, audio messages and other rich media without strict file size limits.

• More features and capabilities- RCS messages support read receipts, typing indicators, and group chats.

• Message delivery and connectivity- RCS uses data or Wi-Fi to send/receive messages which can result in faster and more reliable message delivery.

• Increased security

Who can receive RCS messages?

Android

RCS is currently available for virtually all Android phones (including Samsung) via the Google Messages app.

Apple

Apple introduced RCS support in iOS 18 with supported carriers, allowing iPhone users to send and receive messages with Android users using the RCS standard. RCS messages will appear in green text bubbles, while iMessages appear in blue.

Note that RCS messages with Apple devices aren’t end-to-end encrypted.

What is RCS Business Messaging (RBM)?

RCS Business Messaging, or RBM, is a messaging platform that allows businesses to engage with customers by sending RCS messages. Messages sent via RBM agents will use RCS as the messaging route.

RCS Business Messaging can provide customers with a more engaging and interactive experience.

RCS/RBM Agents

An RCS Agent is the digital identity of the brand seen by the customer when sending RCS messages. This is similar to a Sender ID for SMS message, but with added features such as the brand name, logo and a “verified sender” check mark. This adds branding to conversations, creating a more interactive experience that helps businesses build stronger connections with more trust for customers.

An RBM Agent initiates conversations with customers based on pre-defined triggers. Unlike SMS, a customer can’t text in a keyword to a brand’s RCS agent to hear more, but they can reply to sent messages to create a two-way conversation.

Mobile Text Alerts handles the complexities of agent deployment on every RCS supported carrier network, allowing RCS to easily become another messaging channel for your brand.

How to send RCS messages with the MTA API

When sending RCS messages via the API, Mobile Text Alerts will handle routing messages intelligently based on current subscriber status. For the subscribers included in a /send call, the system will verify whether they are enabled for RCS and then route messages through your agent.

There is also support to configure selecting and sending via multiple brands/agents, and graceful fallback to SMS. See to learn more.

Add the MTA Actions MCP Server

1. Open Claude (web or Desktop app) and click the "Search and tools" icon and select Manage Connectors.

2. Under Connectors, click Add custom connector (or + Add) to begin the connection process.

3. Paste the following MCP Actions Server URL into the connector URL field:

Example prompt: “Using the Mobile Text Alerts connector, list available tools” — Claude should show tool names (Send Message, Schedule Message, Add Subscribers).

When Claude uses this tool, you'll see it appear in the chat view with the MTA name and logo. This can be expanded to view the exact parameters passed in the tool call.

Learn more

Visit to learn more about custom connectors using remote MCP.

What is iMessage?

iMessage is Apple's proprietary, free, and encrypted messaging service for sending text, photos, videos, and more between Apple devices (iPhone, iPad, Mac, Apple Watch, and Apple Vision Pro) using Wi-Fi or cellular data. Known for its "blue bubbles", with iMessage users can send and receive messages with each other, similar to SMS, MMS, or email. iMessage is a secure message ecosystem, with high user trust for sending and receiving iMessages. It is estimated that there are over one billion iMessage users across the globe.

Advantages of iMessage

Globally iMessage has become a highly trusted method of communication due to its security features and ubiquity. iMessages can have a broader reach and better engagement by using an identity synonymous with your brand.

iMessage also has a much higher throughput in terms of media sizes for attachments, which enables higher resolution photos and even videos.

How to send iMessages with Mobile Text Alerts

Header Parameters

Header parameters are included in the request header, all requests to the Mobile Text Alerts API require a valid Authorization header. See Request Headers 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:

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:

Example request to Update Drip Campaign endpoint:

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

• Create Subscriber POST /subscribers

• Get Subscriber GET /subscribers/{idOrNumberOrEmail}

• Update Subscriber PATCH /subscribers/{idOrNumberOrEmail}

• Delete Subscriber

• List Subscribers

• Export Subscribers

See for large scale subscriber updates.

• Create Smart Reply POST /smart-replies

• Get Smart Reply GET /smart-replies/{id}

• Update Smart Reply PATCH /smart-replies/{id}

• Delete Smart Reply DELETE /smart-replies/{id}

• List Smart Replies

Request Headers

Request headers contain information about the client request. Learn more about the header types used by the Mobile Text Alerts API.

Authorization

An API rate limit is a restriction on the number of requests a client can make to an API within a given period of time.

General Rate Limit

Most Mobile Text Alerts API endpoints have a general rate limit of 30 requests per minute per IP address. However, some individual endpoints may override the general rate limit (see below).

Mobile Text Alerts has many built-in AI features to help simplify using our services, and if you’re using AI tools like Claude or Cursor, you can integrate these tools with MTA. MCP (Model Context Protocol) servers for Developer Center and the MTA API can help your AI assistants integrate easily with Mobile Text Alerts.

AI in Platform Dashboard

In the , there are several built-in AI powered features such as:

Mobile Text Alerts offers a robust and powerful Model Context Protocol (MCP) server, unlocking the capabilities to send and manage SMS messaging directly by an AI assistant. This server allows AI assistants and other applications to access your Mobile Text Alerts account from beyond our web and mobile app platforms.

Access the Server

What is 10DLC?

A 10DLC refers to a 10-digit long code in Application-to-Person (A2P) messaging. A 10DLC is a 10-digit phone number for a business that looks like a standard 10-digit phone number with a geographical area code. 10DLCs, toll-free numbers, and short codes are the three primary number types businesses use to engage in A2P text messaging.

10DLC differ from toll-free phone numbers, which have an “800” area code (rather than an area code that is local to a geographical area), and from short codes, which are 5-6 digits. 10DLC requires a special registration process and must comply with US messaging guidelines.

Pros for using 10DLC numbers

• 10DLCs may improve SMS engagement rates. (Receiving a text from a 10-digit number with a local area code can feel more personal than receiving a text from a 5-digit short code or toll-free number.)

• 10DLCs have much lower costs than dedicated short codes, and in many cases are included for free.

• Unregistered 10DLCs typically have better delivery rates than unregistered toll-free numbers.

Cons for using 10DLC numbers

• The registration process costs $15/month (as opposed to toll-free numbers, which are free to register) if you have a low-volume plan.

• Unregistered 10DLCs have throughputs of only 60 messages per minute, much lower than toll-free numbers or short codes.

• Registered 10DLCs have throughputs of around 150 messages per minute, much lower than toll-free numbers or short codes.

• 10DLCs have a daily limit of around 2,000 messages.

10DLC throughput and limits

10DLCs will give you the lowest throughput, at 150 text messages per minute.

The daily limit for 10DLCs is 2,000 messages per day, but can in some cases this can be increased (increases may incur fees from the mobile carriers).

Summary

10DLCs allow for sending mass text messages at an affordable cost, using a local area code which can feel more personable to recipients. Though these benefits make 10DLC an excellent SMS solution for many businesses, MTA generally recommends a toll-free number since toll-free numbers are free and have higher messaging speeds.

Get a 10DLC for sending messages

You can get a free 10DLC with your Mobile Text Alerts account—however, if you would like to register the phone number for better message delivery, the cost is $15/month on the lower plans (it is, however, included for free on most plans).

Learn More

to learn more about 10DLC, registering your brand and more.

View your Numbers with the API

Just as you can view , you can view your all account's numbers and data about them such as name, type, status, and more by calling the endpoint.

Example Request

Example Response

You can check the delivery status of your message sends with Mobile Text Alerts two different ways:

• Call the List Deliveries API endpoint

  • This is best for reporting/analytics of settled message data. This only includes the most recent status for a message.

• Configure the delivery-status webhook

  • This is best for real time status updates, with this webhook you can receive the full status history from the moment of send to the final result status (delivered, rejected etc.).

Call the List Deliveries API endpoint

With the endpoint of the Mobile Text Alerts API you can see a list of all messages sent to all subscribers or you can use query parameters to filter the results. The message status will show the most recent status of a message.

Example query

Filter messages with a delivered delivery status: (note the [] brackets are escaped characters in the cURL request)

Query Parameters

Configure the delivery-status webhook

A delivery-status webhook event is triggered when MTA receives an updated from a provider regarding a sent message. This is best for real time status updates as you can receive the full status history from the moment of send to the final result status (delivered, rejected etc.).

If you haven't configured webhooks for your account see:

Also view the , to learn what fields are sent as part of this webhook.

Subscriber data is stored with predefined subscriber attributes such as First Name, Last Name, Email, etc. You can create your own fields to store any additional types of data for your subscribers. These Custom Subscriber Attributes can be used to help you organize your subscribers to create send lists, form groups and more.

You can add/update/delete your account's Custom Subscriber Attributes in the or with the MTA API.

The below image shows how custom attributes are shown in the platform dashboard, see to learn more.

Manage Custom Subscriber Attributes with the API

How can I send a single “Hello World” message to myself?

You can send a message to your personal phone number for testing and verification. To do this you would send a request to the /send endpoint with the phone number in the subscribers field and the test message in the message field.

Example request:

What is a dedicated short code?

A dedicated short code is a 5 or 6-digit phone number for sending and receiving messages that is exclusively owned by a single brand or organization (example: 52001).

Dedicated short codes have the best throughput (rate of messages sent per second) and the most convenience for users (since they are short, easy to remember, and easy to type into a phone). Dedicated short codes allow sends of 100s or 1000s of messages at once, with high deliverability rates.

What is MCP?

Model Context Protocol (MCP) is an open-source standard developed by in November 2024. MCP defines a shared communication protocol between an AI client (such as a model or assistant) and one or more servers (which provide capabilities, data, or APIs).

MCP servers are backend services that extend AI models like ChatGPT, Claude, Cursor with custom tools, data, or functionality. The goal is to make it possible for AI models to call functions, retrieve data, and work with resources without custom integrations or private APIs. The AI model acts as an MCP client, and includes built-in support for the MCP client interface. When you connect your AI client to an MCP server (such as the MTA MCP Actions server) this allows the model to securely fetch information, run computations, or interact with an external API.

What is a Toll-Free number?

Toll-free SMS numbers are 10-digit numbers with an 800 “area code” as the leading digits (example: 800-780-8000).

Text-enabled toll-free numbers allow you to send messages at decent messaging speeds without adding extra fees.

All accounts at Mobile Text Alerts include a dedicated toll-free number for free.

Toll-free Verification

Toll-free numbers must be verified, this reduces the risk of filtering your message traffic. This is a mandatory industry-wide process that whitelists your text messaging traffic.

When you first create your account, you will need to enter your Brand Registration information. This includes your company's contact information, expected messaging use case and messages, and a Privacy Policy for compliance. After submitting this information, MTA will submit your Toll-Free number to carriers for approval.

You can call the endpoint of the API to see the status of your toll-free number(s) with the field..

Pros for using a toll-free number

• The registration process for toll-free numbers is free.

• Toll-free numbers usually allow for higher messaging speeds than 10DLCs (1,200 messages per minute as opposed to 150 messages per minute).

• Toll-free number registration doesn’t require an EIN/tax ID, so sole proprietors and very small businesses may have an easier time getting registered.

• Toll-free numbers have no daily limits, unlike 10DLCs which have a daily limit of around 2,000.

Cons for using a toll-free number

• Toll-free numbers generally have much slower messaging speeds than short codes (though they are faster than 10DLCs).

• Toll-free numbers may not seem as personable (and therefore not get as much engagement) as 10DLC’s because the “area code” is a generic 800 number.

• Toll-free numbers aren’t as convenient as dedicated short codes, because they are longer numbers.

Toll-free throughput and limits

Toll-free numbers will give you significantly higher throughput than 10DLC’s, at 1,200 text messages per minute.

Unlike 10DLCs, toll-free numbers have no daily limits.

Summary

Mobile Text Alerts generally recommends toll-free numbers over 10DLCs because registration for toll-free numbers is always free, and they have faster messaging speeds. But they do sacrifice the benefit of a personal area code, businesses with a more robust budget may want to consider a dedicated short code.

Get a toll-free number for sending messages

A dedicated toll-free number is included for free with any Mobile Text Alerts subscription. You can get started in seconds to test it out for yourself and for your business today.

Make sure to submit the Brand Registration form that appears at the top of the main dashboard page when you log in to your account.

View your Numbers with the API

Just as you can view , you can view your all account's numbers and data about them such as name, type, status, and more by calling the endpoint.

Verification Status

This endpoint will return the verification status of your toll-free number(s) with tollFreeVerificationStatus this is an ENUM value (0-5) that corresponds with the following statuses:

• 0 - Not Submitted

• 1 - Verification Form Complete

• 2 - Submitted for Review by Carriers

Example request

Example response

With Mobile Text Alerts webhooks you can receive real time notifications of events, such as: sent messages, message replies, and delivery statuses. With the Mobile Text Alerts API you can register, delete, and view the webhooks on your account.

Webhooks Overview

Webhooks are a way for applications to communicate with each other, with real-time data sent from one application to another whenever a given event occurs. For events you want to be notified of, you can configure a webhook to your specified URL.

For example, when a user replies to a message that was sent; MTA receives the inbound message from a provider and will post the inbound message to your provided endpoint.

Event Types

The Mobile Text Alerts API supports the following event types for webhooks:

Message Reply message-reply

When MTA receives an an inbound message from a provider, MTA will post the inbound message to the customer provided endpoint.

View

Delivery Status delivery-status

When MTA receives an updated delivery status from a provider regarding a customer's sent message.

View

Message Send message-send

When MTA send a message to a provider, MTA will post the message to the customer provided endpoint.

View

Number Opt-In number-opt-in

You must receive an inbound opt-in message before you send outbound and . This webhook will post the opt-in event to the customer provided endpoint.

View

Webhook Failure Email Alerts

When registering a webhook, you can choose to receive emails if MTA fails to send a request to your configured URL or a non-200 response code was received. To receive these email alerts: when registering a webhook, set sendAlertEmail to true , with alertEmail set to the intended email address.

Register a Webhook

POST /webhooks

Webhooks can be created for your account by calling the Register Webhooks /webhooks endpoint of the MTA API.

Headers

Request Fields

Response

Learn more

Custom Subscriber Attributes are used to store data of any type that you choose to define for your subscribers. These attributes can be added and updated manually through the platform, automatically from your subscribers via SMS with a workflow, and with the MTA API.

Manage Custom Subscriber Attributes in the Dashboard

Visit the tab in the platform dashboard by selecting Subscribers > Attributes. Here you can view and search all attributes currently available for your subscribers.

Edit or Delete Attributes

Click on a specific attribute to edit it, or click the "trash bin" icon to delete an attribute.

Add Attributes

1. Click the Add Attribute button.

2. Enter the Name of the new attribute.

3. Select the from the following data types under Attribute Type:

   • Text

Example: To create a field to store subscribers' birthdays, you could create the following attribute:

• Name: "Birthday" with the Attribute Type: Date.

Assign Attributes to Subscribers

After your attributes are created, you can assign the data for those attributes to your subscribers manually on the page, or by importing a spreadsheet.

You can also configure your account's to collect subscriber data as part of the enrollment process.

Use a Workflow to collect Subscriber Attributes

Workflow Builder allows you to automatically collect data from your subscribers via SMS.

.

Manage Subscriber Attributes with the MTA API

Add/Update a Subscriber's attributes

Subscriber attributes can be added or updated by including key/value pairs in subscriberFields as part of the request body to one of the endpoints.

The data type of the Custom Subscriber Attribute must match what is configured for that field. For example, the below request uses the following Custom Subscriber Attribute: "name":"Birthday","type":"date","format":"MM/DD/YYYY"

Example Request to Create a Subscriber

MTA will assign each custom attribute a SubscriberFieldId and each subscriber attribute will have a unique id assigned for that instance. This data can be retrieved by viewing the subscriber data from the API.

View Subscriber Attributes

Custom subscriber attributes are returned by the Mobile Text Alerts API in the field subscriberFieldData which contains:

• id - Refers to the specific instance of that field for the specified subscriber

• subscriberFieldId - Identifies the CustomFieldId of the Custom Subscriber Attribute, this can be used to .

• data - the data of this field for the specified subscriber

For example when retrieving a subscriber's data from :

Example Response:

• Get Webinar GET /webinars/{webinarIdentifier}

• List Webinars GET /webinars

• List Webinar Events GET /webinars/events

• Trigger SMS Verification Code POST /verify/sms/send-code

• Check SMS Verification Code POST /verify/sms/check-code

• Get Verification GET /verify/{verificationId}

• List Verifications GET /verify

• Verify Phone Number

• Get Default Reply GET /automated-replies/default-reply

• Update Default Reply PATCH /automated-replies/default-reply

• Get New Subscriber Reply GET /automated-replies/new-subscriber-reply

• Update New Subscriber Reply PATCH /automated-replies/new-subscriber-reply

• Get Controlled Template

• List Controlled Templates

• List Dedicated Numbers

• List Short Codes

For more information on how to use these endpoints see:

• Get Bulk Adaptive Group Member Count

• Bulk Add Subscribers to Group

• Bulk Remove Subscribers from Group

• Create Deeplink

• Create iMessage Deeplink

MMS stands for Multimedia Messaging Service used for sending messages that include a media attachment. MMS messages have a 500 KB size limit, a 1550 character limit, and a higher credit cost per send than SMS.

Credit Costs

• 1 credit cost per SMS message (160 character limit, no attachment)

• 3 credit cost per MMS message (1550 character limit, plus 500KB image attachment)

When to use MMS over SMS

Some situations where MMS is worth using instead of SMS:

• Very long text content

• Sales-oriented content, where an image would can help drive the call-to-action

• Audience is primarily within the US/Canada

• A Mobile Text Alerts plan with rollover and/or excess credits

Supported attachment types

The following file types are supported to use as attachments for MMS:

Attachment hosting with rehost field

You can choose to host the URL of an attachment for an MMS on your own servers, or it can be hosted by MTA. When sending a request to the /send endpoint, if the rehost flag is set to true, the attachment will be rehosted by MTA before sending. This can be useful if the recipient isn't receiving your attachment or you don't want to host the attachment.

How to send an MMS with the API

MMS are sent via the API with a POST request to the /send endpoint just like SMS, but include the image field for the URL of the attachment that will be sent. All requests to this endpoint must contain both recipient and content information.

Required request fields:

• Choose recipient(s): (Must be one of the following)

  • subscriberIds: number[] - List of subscriber IDs of recipients. Messages can be sent to specific subscribers, with each subscriber assigned a unique subscriberId.

  • subscribers: (number | string)[]- List of recipient phone numbers or email addresses. A new subscriber will be created for new recipients that are not already subscribers on your account.

How to send an MMS with the API

Learn More

Pre-set message templates allow you to create a message once and then have it on hand to send at any time. You can create and send message templates in the platform, mobile app and the API.

Use a template to send a message with the API

Templates can be sent in a message by sending a POST request to the /send endpoint. All requests to this endpoint must contain both recipient and content information. When using a message template, the templateId will be used as the content.

Required request fields:

• Choose recipient(s): (Must be one of the following)

  • subscriberIds: number[] - List of subscriber IDs of recipients. Messages can be sent to specific subscribers, with each subscriber assigned a unique subscriberId.

  • subscribers: (number | string)[]- List of recipient phone numbers or email addresses. A new subscriber will be created for new recipients that are not already subscribers on your account.

Send a message template with the API

Using Shortlinks with Controlled 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 with the /shortlinks endpoint.

Templates API endpoints

View all templates

You can call GET /templates to see all the available templates on your account:

View a specific template

To see the details on a specific template, you will need the {id} of the template. Then call GET /templates/{id} :

Update a specific template

To make changes to a specific template, you will need the {id} of the template. Then call PATCH /templates/{id} with the body containing the new template data, message is required.

Example request:

Delete a Template

To remove a specific template, you will need the {id} of the template, then call DELETE /templates/{id}

Create a new template

When creating a new template, the message field is required to hold the content of the message.

Example request:

Template-Only Sending

If your account is configured for template-only message sending, please use the Controlled Template endpoints below to view available templates:

Template Examples

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

• List Groups

Group Member Management

• Add Subscriber to Group

• Delete Subscriber from Group

Group Member Counts

• List All Groups and Member Count

• Get Adaptive Group Member Count

See for large group changes in a single request.

• Create Link POST /links/shortlinks

• Get a tracked Link by ID GET /links/{linkId}

• Add Tags to a Link PATCH /links/{linkId}

• List and Search all tracked Links GET /links

• Get a tracked Link by ID

Subdomains

• Validate Subdomain

• Update Subdomain

• Create Unsubscribe POST /unsubscribes

• Get Unsubscribe for Number GET /unsubscribes/{number}

• List Unsubscribes GET /unsubscribes

• Bulk Unsubscribes POST /unsubscribes/bulk

• List Deliveries GET /deliveries

• Create Tag POST /link-tags

• Get Tag GET /link-tags/{linkTagId}

• Update Tag PATCH /link-tags/{linkTagId}

• Delete Tag DELETE /link-tags/{linkTagId}

• List Tags

When creating or updating many subscribers at one time with the Create Subscriber and Update Subscriber endpoints you can quickly exhaust the available rate limit. The Bulk Create Subscribers and Bulk Update Subscribers endpoints are recommended for handling large subscriber changes via the API, this can save on both request round trip time and overall API call volume.

Bulk Create Subscribers

This endpoint is used to create (or update and create) many subscriber accounts in one request.

CreateOnly Parameter

If set to true the createOnly path parameter indicates the only action should be to create new subscribers and will not update records of existing subscribers. If set to false then both creating or updating (if the subscriber exists) actions will be performed.

Subscriber Request Body

Records of subscribers should be in an array.

Required Fields for new subscribers: email or number

Bulk Update Subscribers

This endpoint is used to update many subscriber accounts in one request. The number field is used to identify the subscriber record to be updated , if no number is provided then email will be used an identifier. One of these fields must be provided to identify the subscriber record to be updated.

Subscriber Request Body

Records of subscribers should be in an array.

• Create Account Variable POST /account-variables

• Get Account Variable GET /account-variables/{idOrTitle}

• Update Account Variable PATCH /account-variables/{idOrTitle}

• Delete Account Variable DELETE /account-variables/{idOrTitle}

• List Account Variables

• Create Custom Field POST /custom-fields

• Get Custom Field GET /custom-fields/{customFieldId}

• Update Custom Field PATCH /custom-fields/{customFieldId}

• Delete Custom Field DELETE /custom-fields/{customFieldId}

• List Custom Fields

• Bulk Create Custom Fields

Bulk Add Subscribers to Group

The POST endpoint can be used to add up to 1,000 subscribers to a single group in a single request.

When adding subscribers to a group you will need the subscriberId of each of the subscribers to add and the groupId of the group that these subscribers will be added to. The subscriberIds

• Get Scheduled Message

• Update Scheduled Message

• Delete Scheduled Message

• List Scheduled Messages

• Get Thread

• Delete Thread

• List Threads

• Mark Thread as Read

The iMessage route also supports graceful fallback for several failure scenarios.

Possible reasons an outbound iMessage may fail:

• The subscriber is not capable of receiving iMessages

• The subscriber has not opted-in via inbound message to the selected Sender Identity

• The Sender Identity has been disabled, blocked, or banned

• Send Message from API

Sending Utilities

• Validate Recipients

• Create Drip Campaign

• Get Drip Campaign

• Update Drip Campaign

• Delete Drip Campaign

For more information on how to use these endpoints see:

• Bulk Create Subscribers

• Bulk Update Subscribers

As with SMS, capturing the proper consent and opt-ins from your recipients is critical to successful usage of iMessage capabilities. Capturing opt-ins ensures that your recipients are expecting the iMessage and gives you the opportunity to identify yourself to the recipient. This ensures that your messages are safely delivered and not marked as spam by the recipient.

iMessage Opt In

You must receive an inbound opt-in message before you send outbound iMessages. An explicit iMessage opt-in is required regardless of whether an opt-in was collected for communications via SMS or email. This can be as simple as sending in "Sign me up" to your Sender Identity.

To help facilitate this, Mobile Text Alerts provides a feature that automatically tracks iMessage opt-ins.

• Get Campaign

• List Campaigns

• Get Campaign Analytics

• List Campaign Options