POST api/email/Save
Request Information
URI Parameters
None.
Body Parameters
EmailVM| Name | Description | Type | Additional information |
|---|---|---|---|
| EmailModel |
None. |
||
| AttachmentVMList | Collection of EmailAttachmentVM |
None. |
|
| SelectedContactDetailForEmailList | Collection of ContactDetailSummaryForEmailByAccountID |
None. |
|
| DocumentListVM | DocumentListVM |
None. |
|
| EmailSessionID | integer |
None. |
|
| OriginalEmailID | integer |
None. |
|
| IsForward | boolean |
None. |
|
| ContactWithID | integer |
None. |
|
| MergeTemplateID | integer |
None. |
|
| CanSend | boolean |
None. |
|
| CanForward | boolean |
None. |
|
| SkipIfEmailDoesNotExist | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{
"Email": {
"EmailID": 1,
"Subject": "sample string 1",
"Email": "sample string 2",
"AccountID": 1,
"PrincipalID": 1,
"CommunicationID": 1,
"Attachments_MediaAndDocumentGroupID": 1,
"MergedFrom_MergeTemplateID": 1,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"FromEmailAddress": "sample string 3",
"ToEmailAddress": "sample string 4",
"CCEmailAddress": "sample string 5",
"BCCEmailAddress": "sample string 6",
"EmailIDEncrypted": "sample string 7"
},
"AttachmentVMList": [
{
"EmailAttachment": {
"EmailAttachmentID": 1,
"EmailID": 1,
"EmailSessionID": 1,
"MediaID": 1,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"TempFileName": "sample string 1"
},
"Media": {
"MediaID": 1,
"MediaTypeID": 1,
"AccountID": 1,
"Description": "sample string 2",
"FileName": "sample string 3",
"FileContents": "QEA=",
"Thumbnail": "QEA=",
"Extension": "sample string 4",
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"DocumentBlobVersionID": 1,
"MediaCategoryID": 1,
"DocumentID": 1,
"EntityID": 1,
"ContactID": 1,
"IsNetworkPath": true,
"ExcludeClientView": true,
"DMSRecordNumber": "sample string 5"
}
},
{
"EmailAttachment": {
"EmailAttachmentID": 1,
"EmailID": 1,
"EmailSessionID": 1,
"MediaID": 1,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"TempFileName": "sample string 1"
},
"Media": {
"MediaID": 1,
"MediaTypeID": 1,
"AccountID": 1,
"Description": "sample string 2",
"FileName": "sample string 3",
"FileContents": "QEA=",
"Thumbnail": "QEA=",
"Extension": "sample string 4",
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"DocumentBlobVersionID": 1,
"MediaCategoryID": 1,
"DocumentID": 1,
"EntityID": 1,
"ContactID": 1,
"IsNetworkPath": true,
"ExcludeClientView": true,
"DMSRecordNumber": "sample string 5"
}
}
],
"SelectedContactDetailForEmailList": [
{
"ContactDetailID": 1,
"ContactDetail": "sample string 2",
"DisplayOrder": 3
},
{
"ContactDetailID": 1,
"ContactDetail": "sample string 2",
"DisplayOrder": 3
}
],
"DocumentListVM": {
"DocumentVM": [
{
"Document": {
"DocumentID": 1,
"Document": "sample string 1",
"DocumentTemplateVersionID": 2,
"AccountID": 3,
"MetaValue_DocumentGroupID": 4,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"Header_DocumentTemplateVersionID": 1,
"Header_MetaValue_DocumentGroupID": 1,
"Footer_DocumentTemplateVersionID": 1,
"Footer_MetaValue_DocumentGroupID": 1,
"DocumentTemplateID": 1
},
"ContactID": 1,
"LetterID": 2,
"Description": "sample string 3",
"CommunicationID": 4
},
{
"Document": {
"DocumentID": 1,
"Document": "sample string 1",
"DocumentTemplateVersionID": 2,
"AccountID": 3,
"MetaValue_DocumentGroupID": 4,
"CreateID": 1,
"CreateSessionID": 1,
"CreateTS": "2025-09-02T23:06:49.1849609+00:00",
"ModifyID": 1,
"ModifySessionID": 1,
"ModifyTS": "2025-09-02T23:06:49.1849609+00:00",
"InactiveID": 1,
"InactiveSessionID": 1,
"InactiveTS": "2025-09-02T23:06:49.1849609+00:00",
"StatusID": 1,
"Z_DB": 1,
"Z_ID": 1,
"Header_DocumentTemplateVersionID": 1,
"Header_MetaValue_DocumentGroupID": 1,
"Footer_DocumentTemplateVersionID": 1,
"Footer_MetaValue_DocumentGroupID": 1,
"DocumentTemplateID": 1
},
"ContactID": 1,
"LetterID": 2,
"Description": "sample string 3",
"CommunicationID": 4
}
]
},
"EmailSessionID": 1,
"OriginalEmailID": 2,
"IsForward": true,
"ContactWithID": 1,
"MergeTemplateID": 1,
"CanSend": true,
"CanForward": true,
"SkipIfEmailDoesNotExist": true
}
application/xml, text/xml
Sample:
<EmailVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Email">
<AttachmentVMList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.EmailAttachment">
<d2p1:EmailAttachmentVM>
<d2p1:EmailAttachment xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.EmailAttachment">
<d4p1:CreateID>1</d4p1:CreateID>
<d4p1:CreateSessionID>1</d4p1:CreateSessionID>
<d4p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d4p1:CreateTS>
<d4p1:EmailAttachmentID>1</d4p1:EmailAttachmentID>
<d4p1:EmailID>1</d4p1:EmailID>
<d4p1:EmailSessionID>1</d4p1:EmailSessionID>
<d4p1:InactiveID>1</d4p1:InactiveID>
<d4p1:InactiveSessionID>1</d4p1:InactiveSessionID>
<d4p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d4p1:InactiveTS>
<d4p1:MediaID>1</d4p1:MediaID>
<d4p1:ModifyID>1</d4p1:ModifyID>
<d4p1:ModifySessionID>1</d4p1:ModifySessionID>
<d4p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d4p1:ModifyTS>
<d4p1:StatusID>1</d4p1:StatusID>
<d4p1:TempFileName>sample string 1</d4p1:TempFileName>
</d2p1:EmailAttachment>
<d2p1:Media xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Media">
<d4p1:AccountID>1</d4p1:AccountID>
<d4p1:ContactID>1</d4p1:ContactID>
<d4p1:CreateID>1</d4p1:CreateID>
<d4p1:CreateSessionID>1</d4p1:CreateSessionID>
<d4p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d4p1:CreateTS>
<d4p1:DMSRecordNumber>sample string 5</d4p1:DMSRecordNumber>
<d4p1:Description>sample string 2</d4p1:Description>
<d4p1:DocumentBlobVersionID>1</d4p1:DocumentBlobVersionID>
<d4p1:DocumentID>1</d4p1:DocumentID>
<d4p1:EntityID>1</d4p1:EntityID>
<d4p1:ExcludeClientView>true</d4p1:ExcludeClientView>
<d4p1:Extension>sample string 4</d4p1:Extension>
<d4p1:FileContents>QEA=</d4p1:FileContents>
<d4p1:FileName>sample string 3</d4p1:FileName>
<d4p1:InactiveID>1</d4p1:InactiveID>
<d4p1:InactiveSessionID>1</d4p1:InactiveSessionID>
<d4p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d4p1:InactiveTS>
<d4p1:IsNetworkPath>true</d4p1:IsNetworkPath>
<d4p1:MediaCategoryID>1</d4p1:MediaCategoryID>
<d4p1:MediaID>1</d4p1:MediaID>
<d4p1:MediaTypeID>1</d4p1:MediaTypeID>
<d4p1:ModifyID>1</d4p1:ModifyID>
<d4p1:ModifySessionID>1</d4p1:ModifySessionID>
<d4p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d4p1:ModifyTS>
<d4p1:StatusID>1</d4p1:StatusID>
<d4p1:Thumbnail>QEA=</d4p1:Thumbnail>
<d4p1:Z_DB>1</d4p1:Z_DB>
<d4p1:Z_ID>1</d4p1:Z_ID>
</d2p1:Media>
</d2p1:EmailAttachmentVM>
<d2p1:EmailAttachmentVM>
<d2p1:EmailAttachment xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.EmailAttachment">
<d4p1:CreateID>1</d4p1:CreateID>
<d4p1:CreateSessionID>1</d4p1:CreateSessionID>
<d4p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d4p1:CreateTS>
<d4p1:EmailAttachmentID>1</d4p1:EmailAttachmentID>
<d4p1:EmailID>1</d4p1:EmailID>
<d4p1:EmailSessionID>1</d4p1:EmailSessionID>
<d4p1:InactiveID>1</d4p1:InactiveID>
<d4p1:InactiveSessionID>1</d4p1:InactiveSessionID>
<d4p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d4p1:InactiveTS>
<d4p1:MediaID>1</d4p1:MediaID>
<d4p1:ModifyID>1</d4p1:ModifyID>
<d4p1:ModifySessionID>1</d4p1:ModifySessionID>
<d4p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d4p1:ModifyTS>
<d4p1:StatusID>1</d4p1:StatusID>
<d4p1:TempFileName>sample string 1</d4p1:TempFileName>
</d2p1:EmailAttachment>
<d2p1:Media xmlns:d4p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Media">
<d4p1:AccountID>1</d4p1:AccountID>
<d4p1:ContactID>1</d4p1:ContactID>
<d4p1:CreateID>1</d4p1:CreateID>
<d4p1:CreateSessionID>1</d4p1:CreateSessionID>
<d4p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d4p1:CreateTS>
<d4p1:DMSRecordNumber>sample string 5</d4p1:DMSRecordNumber>
<d4p1:Description>sample string 2</d4p1:Description>
<d4p1:DocumentBlobVersionID>1</d4p1:DocumentBlobVersionID>
<d4p1:DocumentID>1</d4p1:DocumentID>
<d4p1:EntityID>1</d4p1:EntityID>
<d4p1:ExcludeClientView>true</d4p1:ExcludeClientView>
<d4p1:Extension>sample string 4</d4p1:Extension>
<d4p1:FileContents>QEA=</d4p1:FileContents>
<d4p1:FileName>sample string 3</d4p1:FileName>
<d4p1:InactiveID>1</d4p1:InactiveID>
<d4p1:InactiveSessionID>1</d4p1:InactiveSessionID>
<d4p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d4p1:InactiveTS>
<d4p1:IsNetworkPath>true</d4p1:IsNetworkPath>
<d4p1:MediaCategoryID>1</d4p1:MediaCategoryID>
<d4p1:MediaID>1</d4p1:MediaID>
<d4p1:MediaTypeID>1</d4p1:MediaTypeID>
<d4p1:ModifyID>1</d4p1:ModifyID>
<d4p1:ModifySessionID>1</d4p1:ModifySessionID>
<d4p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d4p1:ModifyTS>
<d4p1:StatusID>1</d4p1:StatusID>
<d4p1:Thumbnail>QEA=</d4p1:Thumbnail>
<d4p1:Z_DB>1</d4p1:Z_DB>
<d4p1:Z_ID>1</d4p1:Z_ID>
</d2p1:Media>
</d2p1:EmailAttachmentVM>
</AttachmentVMList>
<CanForward>true</CanForward>
<CanSend>true</CanSend>
<ContactWithID>1</ContactWithID>
<DocumentListVM xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels.Document">
<d2p1:DocumentVM>
<d2p1:DocumentVM>
<d2p1:CommunicationID>4</d2p1:CommunicationID>
<d2p1:ContactID>1</d2p1:ContactID>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Document xmlns:d5p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Document">
<d5p1:AccountID>3</d5p1:AccountID>
<d5p1:CreateID>1</d5p1:CreateID>
<d5p1:CreateSessionID>1</d5p1:CreateSessionID>
<d5p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d5p1:CreateTS>
<d5p1:Document>sample string 1</d5p1:Document>
<d5p1:DocumentID>1</d5p1:DocumentID>
<d5p1:DocumentTemplateID>1</d5p1:DocumentTemplateID>
<d5p1:DocumentTemplateVersionID>2</d5p1:DocumentTemplateVersionID>
<d5p1:Footer_DocumentTemplateVersionID>1</d5p1:Footer_DocumentTemplateVersionID>
<d5p1:Footer_MetaValue_DocumentGroupID>1</d5p1:Footer_MetaValue_DocumentGroupID>
<d5p1:Header_DocumentTemplateVersionID>1</d5p1:Header_DocumentTemplateVersionID>
<d5p1:Header_MetaValue_DocumentGroupID>1</d5p1:Header_MetaValue_DocumentGroupID>
<d5p1:InactiveID>1</d5p1:InactiveID>
<d5p1:InactiveSessionID>1</d5p1:InactiveSessionID>
<d5p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d5p1:InactiveTS>
<d5p1:MetaValue_DocumentGroupID>4</d5p1:MetaValue_DocumentGroupID>
<d5p1:ModifyID>1</d5p1:ModifyID>
<d5p1:ModifySessionID>1</d5p1:ModifySessionID>
<d5p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d5p1:ModifyTS>
<d5p1:StatusID>1</d5p1:StatusID>
<d5p1:Z_DB>1</d5p1:Z_DB>
<d5p1:Z_ID>1</d5p1:Z_ID>
</d2p1:Document>
<d2p1:LetterID>2</d2p1:LetterID>
</d2p1:DocumentVM>
<d2p1:DocumentVM>
<d2p1:CommunicationID>4</d2p1:CommunicationID>
<d2p1:ContactID>1</d2p1:ContactID>
<d2p1:Description>sample string 3</d2p1:Description>
<d2p1:Document xmlns:d5p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Document">
<d5p1:AccountID>3</d5p1:AccountID>
<d5p1:CreateID>1</d5p1:CreateID>
<d5p1:CreateSessionID>1</d5p1:CreateSessionID>
<d5p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d5p1:CreateTS>
<d5p1:Document>sample string 1</d5p1:Document>
<d5p1:DocumentID>1</d5p1:DocumentID>
<d5p1:DocumentTemplateID>1</d5p1:DocumentTemplateID>
<d5p1:DocumentTemplateVersionID>2</d5p1:DocumentTemplateVersionID>
<d5p1:Footer_DocumentTemplateVersionID>1</d5p1:Footer_DocumentTemplateVersionID>
<d5p1:Footer_MetaValue_DocumentGroupID>1</d5p1:Footer_MetaValue_DocumentGroupID>
<d5p1:Header_DocumentTemplateVersionID>1</d5p1:Header_DocumentTemplateVersionID>
<d5p1:Header_MetaValue_DocumentGroupID>1</d5p1:Header_MetaValue_DocumentGroupID>
<d5p1:InactiveID>1</d5p1:InactiveID>
<d5p1:InactiveSessionID>1</d5p1:InactiveSessionID>
<d5p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d5p1:InactiveTS>
<d5p1:MetaValue_DocumentGroupID>4</d5p1:MetaValue_DocumentGroupID>
<d5p1:ModifyID>1</d5p1:ModifyID>
<d5p1:ModifySessionID>1</d5p1:ModifySessionID>
<d5p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d5p1:ModifyTS>
<d5p1:StatusID>1</d5p1:StatusID>
<d5p1:Z_DB>1</d5p1:Z_DB>
<d5p1:Z_ID>1</d5p1:Z_ID>
</d2p1:Document>
<d2p1:LetterID>2</d2p1:LetterID>
</d2p1:DocumentVM>
</d2p1:DocumentVM>
</DocumentListVM>
<Email xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.Email">
<d2p1:AccountID>1</d2p1:AccountID>
<d2p1:Attachments_MediaAndDocumentGroupID>1</d2p1:Attachments_MediaAndDocumentGroupID>
<d2p1:BCCEmailAddress>sample string 6</d2p1:BCCEmailAddress>
<d2p1:CCEmailAddress>sample string 5</d2p1:CCEmailAddress>
<d2p1:CommunicationID>1</d2p1:CommunicationID>
<d2p1:CreateID>1</d2p1:CreateID>
<d2p1:CreateSessionID>1</d2p1:CreateSessionID>
<d2p1:CreateTS>2025-09-02T23:06:49.1849609+00:00</d2p1:CreateTS>
<d2p1:Email>sample string 2</d2p1:Email>
<d2p1:EmailID>1</d2p1:EmailID>
<d2p1:EmailIDEncrypted>sample string 7</d2p1:EmailIDEncrypted>
<d2p1:FromEmailAddress>sample string 3</d2p1:FromEmailAddress>
<d2p1:InactiveID>1</d2p1:InactiveID>
<d2p1:InactiveSessionID>1</d2p1:InactiveSessionID>
<d2p1:InactiveTS>2025-09-02T23:06:49.1849609+00:00</d2p1:InactiveTS>
<d2p1:MergedFrom_MergeTemplateID>1</d2p1:MergedFrom_MergeTemplateID>
<d2p1:ModifyID>1</d2p1:ModifyID>
<d2p1:ModifySessionID>1</d2p1:ModifySessionID>
<d2p1:ModifyTS>2025-09-02T23:06:49.1849609+00:00</d2p1:ModifyTS>
<d2p1:PrincipalID>1</d2p1:PrincipalID>
<d2p1:StatusID>1</d2p1:StatusID>
<d2p1:Subject>sample string 1</d2p1:Subject>
<d2p1:ToEmailAddress>sample string 4</d2p1:ToEmailAddress>
<d2p1:Z_DB>1</d2p1:Z_DB>
<d2p1:Z_ID>1</d2p1:Z_ID>
</Email>
<EmailSessionID>1</EmailSessionID>
<IsForward>true</IsForward>
<MergeTemplateID>1</MergeTemplateID>
<OriginalEmailID>2</OriginalEmailID>
<SelectedContactDetailForEmailList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.Models.ContactDetail">
<d2p1:ContactDetailSummaryForEmailByAccountID>
<d2p1:ContactDetail>sample string 2</d2p1:ContactDetail>
<d2p1:ContactDetailID>1</d2p1:ContactDetailID>
<d2p1:DisplayOrder>3</d2p1:DisplayOrder>
</d2p1:ContactDetailSummaryForEmailByAccountID>
<d2p1:ContactDetailSummaryForEmailByAccountID>
<d2p1:ContactDetail>sample string 2</d2p1:ContactDetail>
<d2p1:ContactDetailID>1</d2p1:ContactDetailID>
<d2p1:DisplayOrder>3</d2p1:DisplayOrder>
</d2p1:ContactDetailSummaryForEmailByAccountID>
</SelectedContactDetailForEmailList>
<SkipIfEmailDoesNotExist>true</SkipIfEmailDoesNotExist>
</EmailVM>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ActionResultVM| Name | Description | Type | Additional information |
|---|---|---|---|
| Response | IResponse |
None. |
Response Formats
application/json, text/json
Sample:
{
"Response": null
}
application/xml, text/xml
Sample:
<ActionResultVM xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.BusinessObjects.ViewModels"> <Response i:nil="true" /> </ActionResultVM>