1. REST API for Oracle Responsys Marketing Cloud Service
  2. Tasks
  3. Attachments

Merge Trigger Email With Attachments

post

/rest/api/v1.3/campaigns/{campaignName}/emailAttachments

Request

Path Parameters
Body ()
Request Body
Root Schema : Merge Trigger Email With Attachments
Type: object
Title: Merge Trigger Email With Attachments
Show Source
Nested Schema : mergeRule
Type: object
Merge rule used to merge recipient records in a Profile List. Only used during the merge operation.
Show Source
  • Allowed Values: [ "OPTIN", "OPTOUT" ]
    This value must be specified as either OPTIN or OPTOUT and would be applied to all of the records contained in the API call. If this value is not explicitly specified, then it is set to OPTOUT.
  • Value of incoming preferred email format data. For example, 'H' may represent a preference for HTML formatted email.
  • Indicates what should be done for records where a match is not found (true = insert / false = no insert).
  • Allowed Values: [ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
    First match column for determining whether an insert or update should occur.
  • Allowed Values: [ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
    Second match column for determining whether an insert or update should occur. (optional).
  • Allowed Values: [ "NONE", "AND" ]
    Operator to join match column names
  • Value of incoming opt-in status data that represents an opt-in status. For example, 'I' may represent an opt-in status.
  • Value of incoming opt-out status data that represents an optout status. For example, '0' may represent an opt-out status.
  • String containing comma-separated channel codes that if specified will result in record rejection when the channel address field is null. Channel codes are 'E' (Email), 'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has a null for Email or Mobile Number value should be rejected. This parameter can also be set to null or to an empty string, which will cause the validation to not be performed for any channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel.
  • Value of incoming preferred email format data. For example, 'T' may represent a preference for Text formatted email.
  • Allowed Values: [ "REPLACE_ALL", "NO_UPDATE" ]
    Controls how the existing record should be updated.
Nested Schema : mergeTriggerRecordDataWithAttachments
Type: object
Record data that represents Field Names and corresponding values for the recipient.
Show Source
Nested Schema : fieldNames
Type: array
Array of profile list fields that specifies the recipient record data to be sent in the request payload. Must contain the fields specified for matchColumnName1 and, if present, matchColumnName2. May contain other profile list fields as needed.
Show Source
Nested Schema : mergeTriggerRecordsWithAttachments
Type: array
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : attachmentData
Type: array
Attachment data containing array of pairs of file name and content value.
Show Source
Nested Schema : fieldValues
Type: array
Values corresponding to the fieldNames.
Show Source
Nested Schema : optionalData
Type: array
Optional data containing array of name value pairs.
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Trigger Email With Attachments Response
Type: array
Title: Trigger Email With Attachments Response
Array of Recipient Results.
Show Source
Nested Schema : items
Type: object
Response for individual recipient.
Show Source
Back to Top

Examples

Use this interface to merge members into a profile list and subsequently send them an email message with personalized attachments.

IMPORTANT: This is a controlled feature. To have this API enabled for your account, contact your Customer Success Manager (CSM).

Request Notes:

  • The API payload can trigger each batched recipient with their own attachment(s), or with no attachments. To send an email campaign to a recipient that does not include attachments, omit the attachmentData array from the recipient object. (If you send null values in the attachmentData array, the email for the recipient fails with the invalid attachment type error message.)
  • Each attachment must be Base-64 encoded in the API payload. Any personalization of attachments must happen before your client application includes the attachment in the API payload.
  • Default allowed file types are JPEG and JPG, PDF, and ICAL. Ensure that the extension is the correct type for the decoded file, otherwise the recipient will receive the attachment but not be able to open it.
  • If attachments are already configured in the campaign that the API request will trigger, the email sent will include those attachments plus the attachments sent in the API request.
    • Each email can contain a maximum of 10 attachments total (campaign + API payload).
    • Total size of all attachments for a single email is limited to 500 KB.
  • Data attached by the API are scanned before the system creates the files on the server.
  • Use the Get Throttling Limits API to determine how many API requests you can send per minute. A successful response will return a limit, which is how many API requests you can send per minute for this API endpoint.
As with Merge Trigger Email, the following also apply to Merge Trigger Email with Attachments:
  • You can send Responsys Email campaigns that already exist to up to 5 members of a profile list.
  • For the list associated with the specified Email campaign, you must specify an array of record data that contain field names and their corresponding field values.
  • Do not use system column names for the optional data, such as EMAIL_ADDRESS_. This may cause incorrect data to be processed, possibly resulting in skipped records and incorrect data being recorded in the Event table.
  • To pass extended/accented characters in optionalData payload, they must be escaped as Unicode characters. For example, the euro symbol is escaped as \u20AC, the yen symbol is escaped as \u00A5, an is escaped as \u00FC, an is escaped as \u00E9, and the like. Otherwise, you may receive an INVALID_REQUEST_CONTENT error. Please see the definition of merge rule parameters provided in section "Definitions of Rule Parameters for Merging Members into a Profile List".
FIELDS DESCRIPTION
Authorization <AUTH_TOKEN>
Content-Type application/json

Sample Request Body:

   
  {
    "mergeTriggerRecordDataWithAttachments": {
      "mergeTriggerRecordsWithAttachments": [
        {
          "fieldValues": [
            "1",
            "mdi1124@barcorp.com"
          ],
          "optionalData": [
            {
              "name": "CUSTOM1",
              "value": "custom value"
            },
            {
              "name": "CUSTOM2",
              "value": "custom data"
            }
          ],
          "attachmentData": [
            {
              "name": "Hello World.pdf",
              "value": "JVBERi0xLjQKJYCAgIAKMSAwIG9iago8PC9QYWdlcyAyIDAgUiAvVmlld2VyUHJlZmVyZW5jZXMgOCAwIFIgL1R5cGUgL0NhdGFsb2cgPj4KZW5kb2JqCjIgMCBvYmoKPDwvQ291bnQgMSAvTWVkaWFCb3ggWzAgMCA1OTYgODQyIF0gL1R5cGUgL1BhZ2VzIC9SZXNvdXJjZXMgMyAwIFIgL0tpZHMgWzUgMCBSIF0gPj4KZW5kb2JqCjMgMCBvYmoKPDwvRm9udCA3IDAgUiA+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNjAgPj4Kc3RyZWFtCnic0zdUMDZSCEnjcgrhMlQwAEKwgLm5sZ6FuZGBoUJILpeGR2pOTr5CeH5RToqipkJIFpdrCBcAWMsNBgplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmoKPDwvUGFyZW50IDIgMCBSIC9UeXBlIC9QYWdlIC9Db250ZW50cyA0IDAgUiA+PgplbmRvYmoKNiAwIG9iago8PC9CYXNlRm9udCAvQ291cmllci1Cb2xkIC9TdWJ0eXBlIC9UeXBlMSAvRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZyAvVHlwZSAvRm9udCA+PgplbmRvYmoKNyAwIG9iago8PC8xIDYgMCBSID4+CmVuZG9iago4IDAgb2JqCjw8L0Rpc3BsYXlEb2NUaXRsZSB0cnVlID4+CmVuZG9iago5IDAgb2JqCjw8L1N1YmplY3QgKP7/AFMAYQBtAHAAbABlACAAYQBiAG8AdQB0ACAAYQAgAHMAaQBtAHAAbABlACAAJwBoAGUAbABsAG8AIAB3AG8AcgBsAGQAJwAgAHUAcwBpAG4AZwAgAFAARABGACAAQwBsAG8AdwBuKSAvQ3JlYXRvciAo/v8AbwByAGcALgBwAGQAZgBjAGwAbwB3AG4ALgBzAGEAbQBwAGwAZQBzAC4AYwBsAGkALgBIAGUAbABsAG8AVwBvAHIAbABkAFMAYQBtAHAAbABlKSAvQXV0aG9yICj+/wBTAHQAZQBmAGEAbgBvACAAQwBoAGkAegB6AG8AbABpAG4AaSkgL0NyZWF0aW9uRGF0ZSAoRDoyMDExMDMwNTIwMDYxNSswMScwMCcpIC9Qcm9kdWNlciAo/v8AUABEAEYAIABDAGwAbwB3AG4AIABmAG8AcgAgAEoAYQB2AGEAIAAwAC4AMQAuADApIC9UaXRsZSAo/v8AUABEAEYAIABDAGwAbwB3AG4AIAAtACAASABlAGwAbABvACAAdwBvAHIAbABkACAAcwBhAG0AcABsAGUpID4+CmVuZG9iagp4cmVmCjAgMTAKMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAwMDE1IDAwMDAwIG4NCjAwMDAwMDAwODggMDAwMDAgbg0KMDAwMDAwMDE4NyAwMDAwMCBuDQowMDAwMDAwMjE5IDAwMDAwIG4NCjAwMDAwMDAzNDkgMDAwMDAgbg0KMDAwMDAwMDQxMSAwMDAwMCBuDQowMDAwMDAwNTEwIDAwMDAwIG4NCjAwMDAwMDA1MzkgMDAwMDAgbg0KMDAwMDAwMDU4MSAwMDAwMCBuDQp0cmFpbGVyCjw8L1Jvb3QgMSAwIFIgL0luZm8gOSAwIFIgL1NpemUgMTAgPj4Kc3RhcnR4cmVmCjEwMzcKJSVFT0Y="
            },
            {
              "name": "weather.jpg",
              "value": "/9j/4AAQSkZJRgABAQEAYABgAAD/4QA6RXhpZgAATU0AKgAAAAgAA1EQAAEAAAABAQAAAFERAAQAAAABAAAAAFESAAQAAAABAAAAAAAAAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcGBwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCACtANIDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDIkXA4I+lM34Wq6NIW+bP4U4wtIfl4r6A8cknnh8n5l+Y1msMH057ir9vo8k0mSP1qxPpOF2sq/UdqCdWZCzYOM++M1YgvvJPtS3Nh5Jx69DVWaB4m60C1RpxavGV+b86e+pLnaprHJwfypaB8xrfb17sBUkN/Co+8p9s1i0UBzG1dartT5JAPbNUj4gZThmH51Slfy0z1xVOO2kuD8q9TihRDmZ01pd/a8tzRMSW5o0C1+w2P7w/Ofxq4bbzl3ClcopC0ZxkLSrbEnGK1bWEN8vyj1q7Fo6kE7S3qfSlzAcnPpuX3dPrVd4GMm3+H2rrpNFWQH7tU73RVj6df50cwuUw7fSGmb2qx/YhTGPpV2GzaKT5e3Wp/KkmbkcLRcLGWbeSHqtRyu3932rcktZNu1l6/nTP7EaY9Pl9xRzDMRrDz26c1Na6Jsbq26uitfD/ycL2rSg8OLNgMuaOYOU5uOy+zjPeoZolkG3PNdpc6DDbWjMq5YdOOtc5c6aTI21Tkng0lINjE/s//AHaK1DYyZ+8aKq4GXnaKFuljbletPERePvUTWRPILbvXFMC/aXYY8AVe8mO5Tp+IrGSBomrT0y6ZeGx+VS0A86CrpkNu/mKzbnQmlkI6j2FdVavG6LuGB6igsu8jr6UrsDjZfD7Kv3WqGXR3Q9DXcCISt91R68VHNaRlfmVafMLlOFbT5B0FQyQMo+tdgbANG7Kq8dsVVttDF0/zfKvWjmFynJtbMz/MzYzkdauWVsYiNo4rpL/wtGCu0fN71JZeGti58n73enzBymXbHe22ti2td8KkAe9OXRFDDcAh71rWGkxxKo4LHj61LZRkrp7QjIx9KuWbyH725WzjPrW9a6aoI6MT6dK0otGhYfwt9AKjmK5Tk1RnfvnPNNnsfNAyjGuw/sOA4JU59sf4UjaFCw/H07Ucwcpw7acAcKv3u1T2thJG2Ntdh/YMQZj3PTjpUn9mqPxGOe3+eKOYOU5m30ppV9cc9etX7LQMj7u76dx9a2V01FLe/T0FTkAKf4R37UcxRkw6ZGh6qGXPXk8e1S5WItj5ufvY3f57mn3BiCybW6nIA7/5/wA9axtWv5YWO1h83I5pbgQ+JNfWzjbHJPPBzmuO1Lxc0x2suNvTb2rT1p2ul+asC60rzM/L+NaxSM5NkR8TEHr/AOPUVEfDLOd3ltzz1oqtCdTXht/LY/yqUKD2/Srkdvubqo/pTJrFg9Z3KIdilcj73enQW2H/ABpwUDnO1unFC3iRNyd1AFpI2RdvZulAR1k+9j8Kal2twy9h04qYMsT7t27FAFiKNpOMbj3NTS2LSDkq39adYHcrEMCtWEKl9rNtoKSM90wSpqnLbyQS7lbjvWtf239zB68gVlyxzRg8sB0xQSy1BeoUxI3HHBNWJNUjgh6HGPzrBnZk/l0pqzyE9/pQO5pf2n9om/xrQiljtkDK2T+prnd5LZBx9ad9uc9TkelAjrrHUhMPmAUdj6VqWurwxJtbI/H+nauBg1JoDwzVYTxLnqefpS5SuY7ptV3q21e3B3daqzak1sFbdIf1/wDrVyS+ImRdoZtvUjNMl1+R4yob9KXKHMdhF4kVwP3kYyP4hio5vEuG+V48e3+fr+VcK93JyevfrTP7TZRt3H1p8ocx2d34iaePHmYXvWe+v+Wfvtj3Ncy+qsW+9UM+ojZ96nyhzM6Y+I4y3zSD06niql1rqN91g34VzL6nj3qFbmS4bjv6Cq5SeY2bzWVl68/hVeLW9r/LHu+opun6S1y3OcfyroNK8LQy/wAYz70aAY/9sSH/AJZ0V2qeAI3RWDL8wz0oqeZFcrMFrLbyg+tRPas69DWkJoxGDyx9P/r1XNwkbfMehoJMue1kB+63NUpYih/xFdPBPE3O3t9f51Jc6PBfR+ZGyKepU0XsOxysE7Lx8yirkV0ykcbtvar1x4ZBJZfToO9U301oPu02Imh1J4WOON34VYk1Tz8H5QR3z0qjFEDuLjmoGfa+VHHWkBs2d9IT69xk9adcEz99v0rF+3MI/lp1tqjSH5udvrQBfe1SY7d3OO3ekbTwicfNTY7wJ3pBq6huduKAEa2wNrD36VDJZjHy1Yl1ONh71Wn1SJFJ3c0ANEIT71Jsj3Vn3ut4b5fWq66uyty351XKwNhpI0TpUb3gReNvtWXLrygDvzioLnWcp8vy+57UcormhPdST/1qBpCgwWX86x31Znk+U/8A16ltLWe7P3QfTFVawuYtTXCA8uT7CoHuQ38J/OtS08E3F0itj8h0q5aeC1jf95J93jGKV0GpzbTt/wDqqxaXTId1dNa+GLcllbmQdAB+tT2fguFX3MGIHqMfhS5g5WY9lrEh+7+lbOlX7My5jZsH0rSh0Kzgk3SKu0HgetbVjNaW6fu44dv1xmpkzTlII7+Qxr/o8h46+tFWj4gYH7zf98iipKPPE1dj1P60Pq285/yaxt7RtQZ2Na8qMeY24NW8k7lY/wA6sR60R/F19a51blhUiXXNLlHc6iPW933vmx056VH/AGhvb/e4zXPi5x/FQbtl5Bb8KOUZ0TSxiJvmG49qoXEyqTVAXz4+9UckzSmjlAsG9YH5e9ENx5U25s7sVTO5R8tCxyEZz+FUA691lt/ysfwqrJqjE7mbAqOeNhJ83H1qrdQEpkE8c4JoRF2WZ9fbop3VUbUZJHyzflVeirsIuPdCMc/f9KrtdOx64+lNSF5W4VmqxBpjNy35ClogIFV5z3P1NTx6XM6/7PerC2nlnoFz7VoaXAQ3rnoD3o5hooW2k7F3Z+pPatbT71LUhcikj0eS7lKnK89qnPh8wScj7vrUt9xm7H4jaKzCq2CV6jvWVJ4gYyZbjd3pxRo4toXt1zVC8tJJl+VevWpVijWttUVVzn9adN4gZNwUlUb0rMj0i4aEERsfSopLG4I+7s560WQFy58VeRGF3My+hqOXxkxTZHu57e9Z76Qzs26ShLFbYcDc2OtPlQtS5/wkVyf7350VUy3/ADzWinYY+SDFVpYDn045NX3l6jH51XugXU/0oAz5HKHFNWY/X0p0sbBzxUYXH+NBmSeefpTln/Cocc0bS38qANCFxJViOLceKy7eRo5OK0o5mU/WgtMtJppcD0qSKxW3J3dueaba3zR/hRLe+c3v61Ooyvq1uH+ZeB2FZLwMzEbfwrYnk8xdvpRa2SkbjVCsYUGiPdT7V4Hf2q7B4R+f5mP41uWkUcEu7oRUk8oYH+L8KXMxcpUj0BY48IF+Wli0Xd7AVeiyIt235cY60B9vOanmZRVOirHjPNXrDSlXa23pQsigZcj2ol1byeFb2HFGoG1B5OxlMSg4zuHpVS5thcHGMc4AzVO01rL5Y4PqO9Tvq0cnVufXikMcnhvLfe5PpUp0BYju3bvr0qAasyNwabJrLSE/xfjQGhba9jsYdqj6c/8A1q57WNWaST7v6VZklaSVmx+GantNKku3DKi9epoEYsNtNKu5tyA9jTpNO+XO7PsK6j+wMna7fNnGBWhp3hiFJ183aU75p8w+VnCDS5D/AHqK9SGgaeP7v/fQope0Hynm8tmUPQMBUEyxr1Vh7Zq4WUj5i2ap3gw36g1SZJTnVT/CfaqrKrHpVyTk1DJb9TVEyREwTZ0596iZg33R79KkaPccEU0RbfXOc0EhGmH3NVozqqDFVW3dqaXZh92gdy8t8oHP/wCumNqCjpVTymJpTDnuaB8zJm1DLVKt8/aqaRFW7Vbgb5OlAK49L11bnNTRakSOtQhsmnA/7IoKLi6mxjK7jtqGTUWJ71COaVY80APN4z/xGo5LsqDmnCHJ4oFluPOfx7UARx3zBsAcVOt84pgt1h4prpzQBa+2MelSRSSPVWI7StXIZgo/+tSAuWUbFwf0ratbl1QDCrj1NYkNyFqcX7GoA2hcrjnj9ani1XYeu7noQc1hDUcDn5qeNTUfwgUFcx0a62+0bd23HHz0Vzv9qn+83/fVFLlQcxhrIy0jkSLgj8qg8xgOtHmMRWpJIluPrTpbFW6cfWoxNQ03pQBG9jz2pHssr608ynHWk3n1oAg+xKDSi2X+7UuaCMigCFrZVPFOMeRjFSLHxTvIPtQBXWHHb9KkWLI+7Unlle2acNoPdaAIxDtGcU1k54p559acsJPXigCNV2inxpuPtTm2ofu5prS0ASCNY+9BkFQ7qKAHMSxppTNG6jdQA7YoHX605X2Dv+NR7qC9AFhJcNxmpBP7VTWTJpwmIosBbE+TzT1fjg1TE2KBNU8oFzzv9r9aKqeePeijlAioooqgAHFGc0ZozQAoNJRmjNADhSqVHUUwmjNAEnm4HAAppdj+NNooAdvOP/r0FvWm0UALnmkzRRQAUUUUAIRS4oooACM0YoooAay5oCU6igAAoK8UZooAVV3Uvln/AD2puaM0AFFFFAEeaM0zcaXeaAHZopm40bjQA+imbjS7zQA6jNN30m6gCTdSh6i3GjcaAJN9LvqPeaTcaAJd9G/iot5pd5oAk30b6i3mjfQBLvo31FuNG6gCXfRvqLdRuNAEu+jfUW80bjQBLvo31FuNLvoAk30b6i3mjcaAJNxoqPcaKAIPNbFHmtTaKDMcJGAo8xvWm0UAOEjZo81sdabRQA7zWoMjEU2igLilyaUyMe9NooAcZGNHmNjrTaKAuOEjDvR5rU2igB3mtnrR5jetNooAd5jUeY3rTaKAHeY3rR5jZptFADhIw70ea3rTaKAHeY3rR5jY602igB3mNR5rU2igB3mt60U2igLn/9k="
            }
          ]
        },
        {
          "fieldValues": [
            "2",
            "mdi.1234@foobarcorp.com"
          ],
          "optionalData": [
            {
              "name": "FIRST_NAME",
              "value": "jim_1"
            },
            {
              "name": "LAST_NAME",
              "value": "smith_1"
            }
          ],
          "attachmentData": [
            {
              "name": "Hello.pdf",
              "value": "JVBERi0xLjQKJYCAgIAKMSAwIG9iago8PC9QYWdlcyAyIDAgUiAvVmlld2VyUHJlZmVyZW5jZXMgOCAwIFIgL1R5cGUgL0NhdGFsb2cgPj4KZW5kb2JqCjIgMCBvYmoKPDwvQ291bnQgMSAvTWVkaWFCb3ggWzAgMCA1OTYgODQyIF0gL1R5cGUgL1BhZ2VzIC9SZXNvdXJjZXMgMyAwIFIgL0tpZHMgWzUgMCBSIF0gPj4KZW5kb2JqCjMgMCBvYmoKPDwvRm9udCA3IDAgUiA+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNjAgPj4Kc3RyZWFtCnic0zdUMDZSCEnjcgrhMlQwAEKwgLm5sZ6FuZGBoUJILpeGR2pOTr5CeH5RToqipkJIFpdrCBcAWMsNBgplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmoKPDwvUGFyZW50IDIgMCBSIC9UeXBlIC9QYWdlIC9Db250ZW50cyA0IDAgUiA+PgplbmRvYmoKNiAwIG9iago8PC9CYXNlRm9udCAvQ291cmllci1Cb2xkIC9TdWJ0eXBlIC9UeXBlMSAvRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZyAvVHlwZSAvRm9udCA+PgplbmRvYmoKNyAwIG9iago8PC8xIDYgMCBSID4+CmVuZG9iago4IDAgb2JqCjw8L0Rpc3BsYXlEb2NUaXRsZSB0cnVlID4+CmVuZG9iago5IDAgb2JqCjw8L1N1YmplY3QgKP7/AFMAYQBtAHAAbABlACAAYQBiAG8AdQB0ACAAYQAgAHMAaQBtAHAAbABlACAAJwBoAGUAbABsAG8AIAB3AG8AcgBsAGQAJwAgAHUAcwBpAG4AZwAgAFAARABGACAAQwBsAG8AdwBuKSAvQ3JlYXRvciAo/v8AbwByAGcALgBwAGQAZgBjAGwAbwB3AG4ALgBzAGEAbQBwAGwAZQBzAC4AYwBsAGkALgBIAGUAbABsAG8AVwBvAHIAbABkAFMAYQBtAHAAbABlKSAvQXV0aG9yICj+/wBTAHQAZQBmAGEAbgBvACAAQwBoAGkAegB6AG8AbABpAG4AaSkgL0NyZWF0aW9uRGF0ZSAoRDoyMDExMDMwNTIwMDYxNSswMScwMCcpIC9Qcm9kdWNlciAo/v8AUABEAEYAIABDAGwAbwB3AG4AIABmAG8AcgAgAEoAYQB2AGEAIAAwAC4AMQAuADApIC9UaXRsZSAo/v8AUABEAEYAIABDAGwAbwB3AG4AIAAtACAASABlAGwAbABvACAAdwBvAHIAbABkACAAcwBhAG0AcABsAGUpID4+CmVuZG9iagp4cmVmCjAgMTAKMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAwMDE1IDAwMDAwIG4NCjAwMDAwMDAwODggMDAwMDAgbg0KMDAwMDAwMDE4NyAwMDAwMCBuDQowMDAwMDAwMjE5IDAwMDAwIG4NCjAwMDAwMDAzNDkgMDAwMDAgbg0KMDAwMDAwMDQxMSAwMDAwMCBuDQowMDAwMDAwNTEwIDAwMDAwIG4NCjAwMDAwMDA1MzkgMDAwMDAgbg0KMDAwMDAwMDU4MSAwMDAwMCBuDQp0cmFpbGVyCjw8L1Jvb3QgMSAwIFIgL0luZm8gOSAwIFIgL1NpemUgMTAgPj4Kc3RhcnR4cmVmCjEwMzcKJSVFT0Y="
            }
          ]
        },
        {
          "fieldValues": [
            "3",
            "mdi.5678@foobarcorp.com"
          ],
          "optionalData": [
            {
              "name": "FIRST_NAME",
              "value": "jim_2"
            },
            {
              "name": "LAST_NAME",
              "value": "smith_2"
            }
          ],
          "attachmentData": [
            {
              "name": "Bye.asd",
              "value": "JVBERi0xLjQKJYCAgIAKMSAwIG9iago8PC9QYWdlcyAyIDAgUiAvVmlld2VyUHJlZmVyZW5jZXMgOCAwIFIgL1R5cGUgL0NhdGFsb2cgPj4KZW5kb2JqCjIgMCBvYmoKPDwvQ291bnQgMSAvTWVkaWFCb3ggWzAgMCA1OTYgODQyIF0gL1R5cGUgL1BhZ2VzIC9SZXNvdXJjZXMgMyAwIFIgL0tpZHMgWzUgMCBSIF0gPj4KZW5kb2JqCjMgMCBvYmoKPDwvRm9udCA3IDAgUiA+PgplbmRvYmoKNCAwIG9iago8PC9GaWx0ZXIgL0ZsYXRlRGVjb2RlIC9MZW5ndGggNjAgPj4Kc3RyZWFtCnic0zdUMDZSCEnjcgrhMlQwAEKwgLm5sZ6FuZGBoUJILpeGR2pOTr5CeH5RToqipkJIFpdrCBcAWMsNBgplbmRzdHJlYW0KZW5kb2JqCjUgMCBvYmoKPDwvUGFyZW50IDIgMCBSIC9UeXBlIC9QYWdlIC9Db250ZW50cyA0IDAgUiA+PgplbmRvYmoKNiAwIG9iago8PC9CYXNlRm9udCAvQ291cmllci1Cb2xkIC9TdWJ0eXBlIC9UeXBlMSAvRW5jb2RpbmcgL1dpbkFuc2lFbmNvZGluZyAvVHlwZSAvRm9udCA+PgplbmRvYmoKNyAwIG9iago8PC8xIDYgMCBSID4+CmVuZG9iago4IDAgb2JqCjw8L0Rpc3BsYXlEb2NUaXRsZSB0cnVlID4+CmVuZG9iago5IDAgb2JqCjw8L1N1YmplY3QgKP7/AFMAYQBtAHAAbABlACAAYQBiAG8AdQB0ACAAYQAgAHMAaQBtAHAAbABlACAAJwBoAGUAbABsAG8AIAB3AG8AcgBsAGQAJwAgAHUAcwBpAG4AZwAgAFAARABGACAAQwBsAG8AdwBuKSAvQ3JlYXRvciAo/v8AbwByAGcALgBwAGQAZgBjAGwAbwB3AG4ALgBzAGEAbQBwAGwAZQBzAC4AYwBsAGkALgBIAGUAbABsAG8AVwBvAHIAbABkAFMAYQBtAHAAbABlKSAvQXV0aG9yICj+/wBTAHQAZQBmAGEAbgBvACAAQwBoAGkAegB6AG8AbABpAG4AaSkgL0NyZWF0aW9uRGF0ZSAoRDoyMDExMDMwNTIwMDYxNSswMScwMCcpIC9Qcm9kdWNlciAo/v8AUABEAEYAIABDAGwAbwB3AG4AIABmAG8AcgAgAEoAYQB2AGEAIAAwAC4AMQAuADApIC9UaXRsZSAo/v8AUABEAEYAIABDAGwAbwB3AG4AIAAtACAASABlAGwAbABvACAAdwBvAHIAbABkACAAcwBhAG0AcABsAGUpID4+CmVuZG9iagp4cmVmCjAgMTAKMDAwMDAwMDAwMCA2NTUzNSBmDQowMDAwMDAwMDE1IDAwMDAwIG4NCjAwMDAwMDAwODggMDAwMDAgbg0KMDAwMDAwMDE4NyAwMDAwMCBuDQowMDAwMDAwMjE5IDAwMDAwIG4NCjAwMDAwMDAzNDkgMDAwMDAgbg0KMDAwMDAwMDQxMSAwMDAwMCBuDQowMDAwMDAwNTEwIDAwMDAwIG4NCjAwMDAwMDA1MzkgMDAwMDAgbg0KMDAwMDAwMDU4MSAwMDAwMCBuDQp0cmFpbGVyCjw8L1Jvb3QgMSAwIFIgL0luZm8gOSAwIFIgL1NpemUgMTAgPj4Kc3RhcnR4cmVmCjEwMzcKJSVFT0Y="
            }
          ]
        }
      ],
      "fieldNames": [
        "CUSTOMER_ID_",
        "EMAIL_ADDRESS_"
      ]
    },
    "mergeRule": {
      "htmlValue": "H",
      "matchColumnName1": "EMAIL_ADDRESS_",
      "matchColumnName2": null,
      "optoutValue": "O",
      "optinValue": "I",
      "insertOnNoMatch": true,
      "defaultPermissionStatus": "OPTIN",
      "rejectRecordIfChannelEmpty": "E",
      "updateOnMatch": "REPLACE_ALL",
      "textValue": "T",
      "matchOperator": "NONE"
    }
  }

Response Notes:

  • A successful response will have an HTTPS code of 200 OK, and the response payload indicates the success or failure for each recipient.
  • The following errorMessage values are specific to email attachment validations for individual recipients. In each case, success : false for the recipient and the email is not sent.
    • FAILURE: Number of attachments cannot exceed 10 for a recipient. The 10-attachment limit includes both API payload and attachments set for the email campaign by the marketer.
    • FAILURE: Invalid attachment type, allowed types are png, jpg, jpeg, pdf, ical. The system checks both file name and value. In the example above, bye.asd decodes to a PDF file, but because the file extension is incorrect in the file name, this attachment still causes a failure for the recipient.
    • FAILURE: The total size of the attachments cannot exceed 500 KB. The 500 KB size limit for attachments includes both API payload and attachments set for the email campaign by the marketer.
  • If the system detects a virus in one of the attachments, the entire request fails with an HTTPS code 400 Bad Request and the errorCode VIRUS_FOUND. The detail returned in the response payload contains the name of the file containing the virus.

Sample Response

The response returns a status for each recipient record sent in the request payload. In this example:
  • The first record was successfully merged and the email was sent to the recipient whose RIID is 72067.
  • The second record was successfully merged, but the email was undeliverable because the recipient's email deliverability status in his Profile List record was set to "Undeliverable" in Responsys.
  • The third record was successfully merged, but the email was not sent because the attachment had an incorrect file type (Bye.asd). 
  
  [  
    {  
      "errorMessage": null,
      "success": true,      
      "recipientId": 72067
    },
    {  
      "errorMessage": "RECIPIENT_STATUS_UNDELIVERABLE: Recipient deliverability status is undeliverable",
      "success": false,
      "recipientId": -1
    },
    {  
      "errorMessage": "FAILURE: Invalid attachment type, allowed types are png, jpg, jpeg, pdf, ical",
      "success": false,
      "recipientId": 72068
    }
  ]
Back to Top