Request Parameters

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

Header Parameters

Header parameters are included in the request headers. 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:

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

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

Request Bodies

The request body contains the data being transferred. This is particularly important for 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/12345' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Example Campaign Name"
}'