POST Emails

Post email data to the Relationship Intelligence system for enabled users. Email data must be uploaded in chronological order. Each request can include up to 1,000 emails per enabled user and up to 50,000 emails in total.

Params

nameParam typeData TypeExampleRequired
userIdBodyint101Required
handlerTypeBodyint1Required
emailsBodyarraysee belowRequired

Handler Type Params

ValueDescription
1RI
2DQA (not available yet)
3RI & DQA (not availble yet)

Email Object Params

nameParam typeData TypeExampleRequired
uniqueIDBodystringunique_messageID_03252024_01Required
sentDateBodydate-time2024-03-25T15:50:49.390ZRequired
modifiedDateBodydate-time2024-03-25T15:50:49.390ZRequired
senderBodyemail addresssee belowRequired
recipientsToBodyemail address (array)see belowRequired (at least 1)
recipientsCCBodyemail address (array)see belowoptional

Email Address Object Params

nameParam typeData TypeExampleRequired
addressBodystringcontactA@externaldomain.comRequired
nameBodystringContact ARequired

Request

POST {{host}}/api/rest/v4/ri/import/emails
Content-Type: application/json
Authorization: {{auth}}
 
[
  {
    "userId": 101,
    "handlerType": 1,
    "emails": [
      {
        "uniqueId": "unique_string",
        "sentDate": "2024-03-25T15:50:49.390Z",
        "modifiedDate": "2024-03-25T15:50:49.390Z",
        "sender": {
          "address": "first.last@firmdomain.com",
          "name": "First Last"
        },
        "recipientsTo": [
          {
            "address": "contactA@externaldomain.com",
            "name": "Contact A"
          }
        ],
        "recipientsCc": [
          {
            "address": "contactB@externaldomain.com",
            "name": "Contact B"
          }
        ]
      }
    ]
  }
]

Responses

HTTP/1.1 200 OK
[
  {
    "userId": 101,
    "status": 1,
    "statusText": "Success",
    "operationStats": {
      "syncDate": "2024-03-25T15:50:49.387Z",
      "received": 1,
      "added": 1,
      "alreadyProcessed": 0,
      "skipped": 0
    },
    "warnings": []
  }
]