Retrieve Push/Message Center Campaign Properties
Use this interface to retrieve a push or message center campaign’s properties. A successful response returns the campaign object properties.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/push/v1.3/campaigns/{campaignName}
Required Path Parameters:
campaignName - Name of the campaign to be retrieved.
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 a push campaign.
{
"campaignMetadata": {
"folderName": "<folderName>",
"description": "<description>",
"marketingStrategy": "<marketingStrategy>",
"marketingProgram": "<marketingProgram>",
"appName": "<appName>",
"channelListName": "<channelListName>",
"type": "Push",
"campaignName": "<campaignName>"
},
"dataSource": {
"dataSourceTables": [
{
"folder": "<dataSourceFolderName>",
"type": "<dataSourceType>",
"alias": "<dataSourceAlias>",
"name": "<dataSourceName>",
"columns": [
{
"alias": "<columnAlias>",
"defaultValue": null,
"name": "<columnName>",
"lookupKey": false
},
]
},
],
"dynamicVariables": {
"columns": [
{
"alias": "<dynamicVariableAlias>",
"defaultValue": null
}
]
}
},
"message": {
"title": "<title>",
"textMessage": "<textMessage>",
"iosMedialUrl": "<iosMediaUrl>",
"androidImageUrl": "<androidImageUrl>",
"deepLinkUrl": "<deepLinkUrl>"
},
"launchSettings": {
"progressEmailAddresses": [],
"skipAlertEnabled": false,
"skipAlertPercent": 0,
"sentAlertEnabled": false,
"sentAlertPercent": 100,
"startAlertEnabled": false,
"emptyAlertEnabled": false,
"failureEmailAddresses": [],
"skippedLaunchEmailAddresses": [],
"launchThrottleRate": null
},
"targeting": {
"filterNames": <filterNames>,
"audienceName": <audienceName>,
"allRecipients": <allRecipients>
},
"links": [
{
"rel": "self",
"href": "/pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "GET"
},
{
"rel": "updatePushCampaign",
"href": "/pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "PUT"
},
{
"rel": "deletePushCampaign",
"href": "/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "DELETE"
},
{
"rel": "createPushCampaign",
"href": "/pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "POST"
}
]
}
Retrieve a message center campaign's properties.
{
"campaignMetadata": {
"folderName": "<folderName>",
"description": "<campaignDescription>",
"marketingStrategy": "<marketingStrategy>",
"marketingProgram": "<marketingProgram>",
"appName": "<appName>",
"channelListName": "<channelListName>",
"type": "MessageCenter",
"campaignName": "<campaignName>",
"purpose": "<campaignPurpose>"
},
"message": {
"textMessage": "<textMessage>",
"deepLinkUrl": "<deepLinkUrl>",
"destinationMessageCenter": "<messageCenterName>",
"subject": "<messageSubject>",
"messageIconUrl": "<messageIconURL>",
"relativeExpiryDateOffset": "<expiryDateOffset>",
"badgeOption": "<badgeOption>",
"badgeCount": "<badgeCount>"
},
"dataSource": {
"dataSourceTables": [
{
"folder": "<dataSourceFolderName>",
"type": "<dataSourceType>",
"alias": "<dataSourceAlias>",
"name": "<dataSourceName>",
"columns": [
{
"alias": "<columnAlias>",
"defaultValue": <defaultValue>,
"name": "<columnName>",
"lookupKey": false
}
]
}
],
"dynamicVariables": {
"columns": [
{
"alias": "<dynamicVariableAlias>",
"defaultValue": null
}
]
}
},
"targeting": {
"filterNames": [
],
"audienceName": <audienceName>,
"allRecipients": true
},
"launchSettings": {
"progressEmailAddresses": [
"<progressEmailAddress1>",
"<progressEmailAddress2>"
],
"skipAlertEnabled": true,
"skipAlertPercent": <skipAlertPercent>,
"sentAlertEnabled": false,
"sentAlertPercent": null,
"startAlertEnabled": false,
"emptyAlertEnabled": false,
"failureEmailAddresses": [
"<failureEmailAddress1>",
"<failureEmailAddress2>"
],
"skippedLaunchEmailAddresses": [
"<skippedLaunchEmailAddress>"
],
"launchThrottleRate": <launchThrottleRate>
},
"links": [
{
"rel": "self",
"href": "/pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "GET"
},
{
"rel": "deletePushCampaign",
"href": "//pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "DELETE"
},
{
"rel": "updatePushCampaign",
"href": "//pushapi/rest/api/push/v1.3/campaigns/<campaignName>",
"method": "PUT"
},
{
"rel": "createPushCampaign",
"href": "//pushapi/rest/api/push/v1.3/campaigns/messagecenter/<campaignName>",
"method": "POST"
}
]
}