POST api/v2.0/Messaging/MarkMessagesAsRead
Marks the specified Mailbox Messages as 'Read'.
Request Information
URI Parameters
None.
Body Parameters
List of MessageKeys
Collection of globally unique identifierRequest Formats
application/json, text/json
Sample:
[ "b2532fb2-2aa0-4358-ac1d-54b2797ad8a7", "bc2f1aaf-713f-428a-814a-8a371b21048f" ]
application/xml, text/xml
Sample:
<ArrayOfguid xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <guid>b2532fb2-2aa0-4358-ac1d-54b2797ad8a7</guid> <guid>bc2f1aaf-713f-428a-814a-8a371b21048f</guid> </ArrayOfguid>
Response Information
Resource Description
A list of the results. If any of the Messages could not be marked as read, an error message will be included.
Collection of MarkMessageAsReadResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| MessageKey |
Unique Identifier of an Inbox Message. |
globally unique identifier |
None. |
| Success |
Indicates if the message was succesfully marked as Read. |
boolean |
None. |
| ResponseMessage |
Additional information such as the reason for a failure. |
string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"MessageKey": "20cf33ee-cc93-4cf1-8795-a747967f2824",
"Success": true,
"ResponseMessage": "sample string 3"
},
{
"MessageKey": "20cf33ee-cc93-4cf1-8795-a747967f2824",
"Success": true,
"ResponseMessage": "sample string 3"
}
]
application/xml, text/xml
Sample:
<ArrayOfMarkMessageAsReadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Messaging">
<MarkMessageAsReadResponse>
<MessageKey>20cf33ee-cc93-4cf1-8795-a747967f2824</MessageKey>
<ResponseMessage>sample string 3</ResponseMessage>
<Success>true</Success>
</MarkMessageAsReadResponse>
<MarkMessageAsReadResponse>
<MessageKey>20cf33ee-cc93-4cf1-8795-a747967f2824</MessageKey>
<ResponseMessage>sample string 3</ResponseMessage>
<Success>true</Success>
</MarkMessageAsReadResponse>
</ArrayOfMarkMessageAsReadResponse>