Retrieve All Push/Message Center Campaigns
Use this interface to retrieve push or message center campaigns. The response returns the campaign’s name, folder, and the name of the app.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/push/v1.3/campaigns?type=<campaignType>
Required Query Parameters:
-
campaignType: The campaign type to search.-
For Push campaigns, you must include
type=push. Not case sensitive. -
For Message Center campaigns,
type=messagecenter. Not case sensitive.
-
Optional Query 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
Sample Response Body - Success
Retrieve push campaign.
{
"campaigns": [
{
"campaignName": "<campaignName1>",
"appName": "<app1Name>",
"folderName": "<folderName1>",
"campaignType": "Push"
},
{
"campaignName": "<campaignName2>",
"appName": "<appName2>",
"folderName": "<folderName2>",
"campaignType": "Push"
}
]
}
Retrieve message center campaigns.
{
"campaigns": [
{
"campaignName": "<campaignName1>",
"folderName": "<folderName>",
"campaignType": "MessageCenter",
"appName": "<appName>"
},
{
"campaignName": "<campaignName2>",
"folderName": "<folderName>",
"campaignType": "MessageCenter",
"appName": "<appName>"
}
]