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 identifier

Request Formats

application/json, text/json

Sample:

[
  "3d5ee39c-4394-4f43-903f-80c8547df516",
  "9c711243-9783-4f42-8650-5c2a032cd2d3"
]

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>3d5ee39c-4394-4f43-903f-80c8547df516</guid>
  <guid>9c711243-9783-4f42-8650-5c2a032cd2d3</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": "c728823a-af6f-4702-8108-645bbd1ee647",
    "Success": true,
    "ResponseMessage": "sample string 3"
  },
  {
    "MessageKey": "c728823a-af6f-4702-8108-645bbd1ee647",
    "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>c728823a-af6f-4702-8108-645bbd1ee647</MessageKey>
    <ResponseMessage>sample string 3</ResponseMessage>
    <Success>true</Success>
  </MarkMessageAsReadResponse>
  <MarkMessageAsReadResponse>
    <MessageKey>c728823a-af6f-4702-8108-645bbd1ee647</MessageKey>
    <ResponseMessage>sample string 3</ResponseMessage>
    <Success>true</Success>
  </MarkMessageAsReadResponse>
</ArrayOfMarkMessageAsReadResponse>