Get all MMS campaigns

Use this interface to get MMS all campaigns and their properties.

Important: To use the Get All Campaigns API to obtain MMS campaigns, your account must be enabled for MMS. Otherwise using the call will result in an error (HTTPS status code 401 Unauthorized and error code API_DISABLED_FOR_USER).

Service URL:

/rest/api/v1.3/campaigns?type=mms

Required Path Parameters:

type: For MMS campaigns, you must include type=mms.

Optional Path Parameters:

Tip: Leave the following parameters set to their default values and use the “prev” and “next” links returned in the response to get additional campaigns as needed.

• offset: starts at 0 and indicates the record number for the response result set (defaults to 0).
• limit: number of campaigns to return in the response (defaults to 200 and cannot exceed 200).

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

Not applicable

Sample Request Body

Not applicable

Response Body Notes:

• The response contains an array of up to 200 campaign objects per request.
• Each item in the array contains a campaign object, which includes the campaign ID and the campaign’s other properties.
• The campaign properties returned in the response may vary, depending on what was configured for the campaign when it was created.
• The response also contains a links array for the “Get all campaigns” interface for MMS campaign objects. This array contains the endpoints for obtaining the previous and next batch of campaign objects.

• The response body for MMS includes some EMD campaign attributes, even though they are not available in the MMS campaign workbook. These values are set either to “false” or to the account-level settings.

  Examples:

     "trackHTMLOpens": false,
     "trackConversions": false,
     "sendTextIfHTMLUnknown": false

Sample Response Body

The endpoint /rest/api/v1.3/campaigns?type=mms returned the following response (for brevity, the sample shows only the first and last campaigns of the full list of campaigns returned.):

{
  "campaigns": [
    {
      "id": 10016762,
      "name": "test-mms",
      "folderName": "examples",
      "type": "MmsCampaign",
      "purpose": "PROMOTIONAL",
      "textMessagePath": "/messagelibrary/mms/10016762/Message.txt",
      "enableLinkTracking": false,
      "attachmentPaths": [
        null
      ],
      "enableExternalTracking": false,
      "useUTF8": false,
      "trackHTMLOpens": false,
      "trackConversions": false,
      "sendTextIfHTMLUnknown": false,
      "autoCloseOption": "None"
    },
    .
    .
    .
    {
      "id": 11081025,
      "name": "AG_AudienceTest_MMS",
      "folderName": "AG-Test",
      "type": "MmsCampaign",
      "purpose": "PROMOTIONAL",
      "listName": "2018 list",
      "textMessagePath": "/messagelibrary/mms/11081025/Message.txt",
      "enableLinkTracking": false,
      "attachmentPaths": [
        "/contentlibrary/2018_content^sale70.jpg"
      ],
      "enableExternalTracking": false,
      "useUTF8": false,
      "trackHTMLOpens": false,
      "trackConversions": false,
      "sendTextIfHTMLUnknown": false,
      "autoCloseOption": "None"
    }
  ],
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/campaigns?type=mms",
      "method": "GET"
    }
  ]
}