Create Message Center Campaign

Use this interface to create a message center campaign object.

Note: The Responsys Advanced API is generally available for all Responsys customers.

Service URL:

/rest/api/push/v1.3/campaigns/messagecenter/{campaignName}

Required Path Parameters:

campaignName - Name of the message center campaign to be created.

Request Method:

POST

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body - Required Properties:

See Message Center Campaigns Object Properties Reference for more information.

Sample Request Body

{
  "campaignMetadata": {
    "folderName": "<folderName>",
    "description": "<campaignDescription>",
    "marketingStrategy": "<marketingStrategy>",
    "marketingProgram":" <marketingProgram>",
    "appName": "<appName>",
    "purpose": "<campaignPurpose>"
  },
  "message": {
    "textMessage": "<textMessage>",
    "deepLinkUrl": "<deepLinkUrl>",
    "destinationMessageCenter": "<messageCenterName>",
    "subject": "<messageSubject>",
    "messageIconUrl": "<messageIconURL>",
    "relativeExpiryDateOffset": "<expiryDateOffset>",
    "badgeOption": "<badgeOption>",
    "expiryDate": "<expiryDate>",
    "badgeCount": "<badgeCount>",
    "richMessagePath": "<richMessagePath>",
    "richMessageExternalUrl": "<richMessageExternalURL>"
  },
  "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
        }
      ]
    }
  },
  "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>
  }
}

Sample Response Body - Success

{
  "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"
    }
  ]
}

Learn more

Push Campaigns

Message Center

Advanced API Resources