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
name | Param type | Data Type | Example | Required |
---|---|---|---|---|
userId | Body | int | 101 | Required |
handlerType | Body | int | 1 | Required |
emails | Body | array | see below | Required |
Handler Type Params
Value | Description |
---|---|
1 | RI |
2 | DQA (not available yet) |
3 | RI & DQA (not availble yet) |
Email Object Params
name | Param type | Data Type | Example | Required |
---|---|---|---|---|
uniqueID | Body | string | unique_messageID_03252024_01 | Required |
sentDate | Body | date-time | 2024-03-25T15:50:49.390Z | Required |
modifiedDate | Body | date-time | 2024-03-25T15:50:49.390Z | Required |
sender | Body | email address | see below | Required |
recipientsTo | Body | email address (array) | see below | Required (at least 1) |
recipientsCC | Body | email address (array) | see below | optional |
Email Address Object Params
name | Param type | Data Type | Example | Required |
---|---|---|---|---|
address | Body | string | contactA@externaldomain.com | Required |
name | Body | string | Contact A | Required |
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": []
}
]