POST api/v1/ArchiveMail
Request Information
URI Parameters
None.
Body Parameters
MailInfo| Name | Description | Type | Additional information |
|---|---|---|---|
| Original_Conversation_ID | string |
None. |
|
| MessageID | string |
None. |
|
| Orig_Date | date |
None. |
|
| Sender | string |
None. |
|
| Subject | string |
None. |
|
| BodyText | string |
None. |
|
| Email_Type | integer |
None. |
|
| HasAttachment | boolean |
None. |
|
| Normalized_Subject | string |
None. |
|
| Size | integer |
None. |
|
| Class | string |
None. |
|
| Mail_Created_Time | date |
None. |
|
| Mail_Retrieval_Time | date |
None. |
|
| Priority | integer |
None. |
|
| Direction | boolean |
None. |
|
| Sensitivity | Sensitivity |
None. |
|
| MetadataWorkPointSequenceNumber | string |
None. |
|
| Email_Blob | Collection of byte |
None. |
|
| FromAddress | EmailAddress |
None. |
|
| ToAddresses | Collection of EmailAddress |
None. |
|
| CcAddresses | Collection of EmailAddress |
None. |
|
| BccAddresses | Collection of EmailAddress |
None. |
Request Formats
application/json, text/json
Sample:
{
"Original_Conversation_ID": "sample string 1",
"MessageID": "sample string 2",
"Orig_Date": "2025-10-29T00:28:20.587662+00:00",
"Sender": "sample string 4",
"Subject": "sample string 5",
"BodyText": "sample string 6",
"Email_Type": 7,
"HasAttachment": true,
"Normalized_Subject": "sample string 9",
"Size": 10,
"Class": "sample string 11",
"Mail_Created_Time": "2025-10-29T00:28:20.587662+00:00",
"Mail_Retrieval_Time": "2025-10-29T00:28:20.587662+00:00",
"Priority": 14,
"Direction": true,
"Sensitivity": 10,
"MetadataWorkPointSequenceNumber": "sample string 16",
"Email_Blob": "QEA=",
"FromAddress": {
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
},
"ToAddresses": [
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
},
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
}
],
"CcAddresses": [
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
},
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
}
],
"BccAddresses": [
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
},
{
"DisplayName": "sample string 1",
"Address": "sample string 2",
"Part": "sample string 3",
"IsGroup": true,
"ParentAddress": "sample string 5"
}
]
}
application/xml, text/xml
Sample:
<MailInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
<BccAddresses>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
</BccAddresses>
<BodyText>sample string 6</BodyText>
<CcAddresses>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
</CcAddresses>
<Class>sample string 11</Class>
<Direction>true</Direction>
<Email_Blob>QEA=</Email_Blob>
<Email_Type>7</Email_Type>
<FromAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</FromAddress>
<HasAttachment>true</HasAttachment>
<Mail_Created_Time>2025-10-29T00:28:20.587662+00:00</Mail_Created_Time>
<Mail_Retrieval_Time>2025-10-29T00:28:20.587662+00:00</Mail_Retrieval_Time>
<MessageID>sample string 2</MessageID>
<MetadataWorkPointSequenceNumber>sample string 16</MetadataWorkPointSequenceNumber>
<Normalized_Subject>sample string 9</Normalized_Subject>
<Orig_Date>2025-10-29T00:28:20.587662+00:00</Orig_Date>
<Original_Conversation_ID>sample string 1</Original_Conversation_ID>
<Priority>14</Priority>
<Sender>sample string 4</Sender>
<Sensitivity>Normal</Sensitivity>
<Size>10</Size>
<Subject>sample string 5</Subject>
<ToAddresses>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
<EmailAddress>
<Address>sample string 2</Address>
<DisplayName>sample string 1</DisplayName>
<IsGroup>true</IsGroup>
<ParentAddress>sample string 5</ParentAddress>
<Part>sample string 3</Part>
</EmailAddress>
</ToAddresses>
</MailInfo>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResponseOfInt32| Name | Description | Type | Additional information |
|---|---|---|---|
| Data | integer |
None. |
|
| Error | ServiceError |
None. |
|
| IsError | boolean |
None. |
|
| Warning | string |
None. |
|
| Misc1 | Object |
None. |
|
| Misc2 | Object |
None. |
|
| Misc3 | Object |
None. |
|
| Exception | Exception |
None. |
Response Formats
application/json, text/json
Sample:
{
"Data": 1,
"Error": {
"Message": "sample string 1",
"ErrorNumber": 2,
"AddtionalInfo": {
"sample string 1": "sample string 2",
"sample string 3": "sample string 4"
},
"TimeStamp": "2025-10-29T00:28:20.603284+00:00"
},
"IsError": true,
"Warning": "sample string 3",
"Misc1": {},
"Misc2": {},
"Misc3": {},
"Exception": {
"ClassName": "System.Exception",
"Message": null,
"Data": null,
"InnerException": null,
"HelpURL": "sample string 1",
"StackTraceString": null,
"RemoteStackTraceString": null,
"RemoteStackIndex": 0,
"ExceptionMethod": null,
"HResult": 3,
"Source": "sample string 2",
"WatsonBuckets": null
}
}
application/xml, text/xml
Sample:
<ServiceResponseOfint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.workpointemm.dk/API">
<Data>1</Data>
<Error>
<AddtionalInfo xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 1</d3p1:Key>
<d3p1:Value>sample string 2</d3p1:Value>
</d3p1:KeyValueOfstringstring>
<d3p1:KeyValueOfstringstring>
<d3p1:Key>sample string 3</d3p1:Key>
<d3p1:Value>sample string 4</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</AddtionalInfo>
<ErrorNumber>2</ErrorNumber>
<Message>sample string 1</Message>
<TimeStamp>2025-10-29T00:28:20.603284+00:00</TimeStamp>
</Error>
<Exception xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<ClassName xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">System.Exception</ClassName>
<Message i:nil="true" xmlns="" />
<Data i:nil="true" xmlns="" />
<InnerException i:nil="true" xmlns="" />
<HelpURL xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 1</HelpURL>
<StackTraceString i:nil="true" xmlns="" />
<RemoteStackTraceString i:nil="true" xmlns="" />
<RemoteStackIndex xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">0</RemoteStackIndex>
<ExceptionMethod i:nil="true" xmlns="" />
<HResult xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:int" xmlns="">3</HResult>
<Source xmlns:d3p1="http://www.w3.org/2001/XMLSchema" i:type="d3p1:string" xmlns="">sample string 2</Source>
<WatsonBuckets i:nil="true" xmlns="" />
</Exception>
<IsError>true</IsError>
<Misc1 />
<Misc2 />
<Misc3 />
<Warning>sample string 3</Warning>
</ServiceResponseOfint>