GET api/v2/messages/{messageId}
Request
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| messageId | integer |
Required |
Response
MessageDetail| Name | Description | Type | Additional information |
|---|---|---|---|
| Identifier | string | ||
| EditionUser | UserBasic | ||
| EditionDateTime | date | ||
| Id | integer | ||
| Active | boolean | ||
| Subject | string | ||
| MessageID | string | ||
| Folder | string | ||
| EmailFrom | string | ||
| Sent | date | ||
| SentExternal | date | ||
| AccountFrom | AccountBasic | ||
| MessageType | MessageTypeBasic | ||
| MessageTextPlan | string | ||
| Draft | boolean | ||
| Urgent | boolean | ||
| NotificationCenter | boolean |
Response Format
application/json, text/json
Sample:
{
"Identifier": "sample string 1",
"EditionUser": {
"Active": true,
"CultureId": "sample string 2",
"Login": "sample string 3",
"Email": "sample string 4",
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:10:32.6318717Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ServiceArea": {
"ServiceCenter": {
"Active": true,
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:10:32.6318717Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Id": 2,
"Identification": "sample string 3"
},
"ExtraTime": 1,
"ExternalServiceArea": true,
"Active": true,
"Id": 3,
"Identification": "sample string 4"
},
"Account": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:10:32.6318717Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"SignatureCertFileId": 1,
"LicenseGroup": {
"Id": 1,
"Identification": "sample string 2",
"UserReadOnlyAccessCount": 3,
"UserEditableAccessCount": 4
},
"ReadOnlyAccess": true,
"Reserved": true,
"ServiceAreaId": 1,
"ExternalUser": "sample string 5",
"Id": 6,
"Identification": "sample string 7"
},
"EditionDateTime": "2026-02-02T21:10:32.6318717Z",
"Id": 2,
"Active": true,
"Subject": "sample string 4",
"MessageID": "sample string 5",
"Folder": "sample string 6",
"EmailFrom": "sample string 7",
"Sent": "2026-02-02T21:10:32.6318717Z",
"SentExternal": "2026-02-02T21:10:32.6318717Z",
"AccountFrom": {
"Complement": "sample string 1",
"ReferenceKey": "sample string 2",
"AccountType": {
"Active": true,
"RequireRegistryNumber": true,
"AccountTypeRegistryTypeId": 1,
"Id": 3,
"Identification": "sample string 4"
},
"PriceList": {
"Active": true,
"Expire": "2026-02-02T21:10:32.6318717Z",
"ConsiderServiceCenterPriceListFromSampleOrWork": true,
"Id": 3,
"Identification": "sample string 4"
},
"Active": true,
"RelatedAccountRequired": true,
"RegistryNumber": "sample string 5",
"CultureId": "sample string 6",
"Id": 7,
"Identification": "sample string 8"
},
"MessageType": {
"Id": 1,
"SId": 1,
"Identification": "sample string 2"
},
"MessageTextPlan": "sample string 8",
"Draft": true,
"Urgent": true,
"NotificationCenter": true
}
text/html
Sample:
{"Identifier":"sample string 1","EditionUser":{"Active":true,"CultureId":"sample string 2","Login":"sample string 3","Email":"sample string 4","ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:10:32.6318717Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ServiceArea":{"ServiceCenter":{"Active":true,"PriceList":{"Active":true,"Expire":"2026-02-02T21:10:32.6318717Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Id":2,"Identification":"sample string 3"},"ExtraTime":1,"ExternalServiceArea":true,"Active":true,"Id":3,"Identification":"sample string 4"},"Account":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:10:32.6318717Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"SignatureCertFileId":1,"LicenseGroup":{"Id":1,"Identification":"sample string 2","UserReadOnlyAccessCount":3,"UserEditableAccessCount":4},"ReadOnlyAccess":true,"Reserved":true,"ServiceAreaId":1,"ExternalUser":"sample string 5","Id":6,"Identification":"sample string 7"},"EditionDateTime":"2026-02-02T21:10:32.6318717Z","Id":2,"Active":true,"Subject":"sample string 4","MessageID":"sample string 5","Folder":"sample string 6","EmailFrom":"sample string 7","Sent":"2026-02-02T21:10:32.6318717Z","SentExternal":"2026-02-02T21:10:32.6318717Z","AccountFrom":{"Complement":"sample string 1","ReferenceKey":"sample string 2","AccountType":{"Active":true,"RequireRegistryNumber":true,"AccountTypeRegistryTypeId":1,"Id":3,"Identification":"sample string 4"},"PriceList":{"Active":true,"Expire":"2026-02-02T21:10:32.6318717Z","ConsiderServiceCenterPriceListFromSampleOrWork":true,"Id":3,"Identification":"sample string 4"},"Active":true,"RelatedAccountRequired":true,"RegistryNumber":"sample string 5","CultureId":"sample string 6","Id":7,"Identification":"sample string 8"},"MessageType":{"Id":1,"SId":1,"Identification":"sample string 2"},"MessageTextPlan":"sample string 8","Draft":true,"Urgent":true,"NotificationCenter":true}