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:
[
  "a5766fd9-a196-4848-8cb7-8d46c692d898",
  "c7e6e83c-5080-4f20-b4ca-71b15c27e64d"
]

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>a5766fd9-a196-4848-8cb7-8d46c692d898</guid>
  <guid>c7e6e83c-5080-4f20-b4ca-71b15c27e64d</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
NameDescriptionTypeAdditional 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": "c12a59e9-2c83-4d6e-b479-2653d31bffde",
    "Success": true,
    "ResponseMessage": "sample string 3"
  },
  {
    "MessageKey": "c12a59e9-2c83-4d6e-b479-2653d31bffde",
    "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>c12a59e9-2c83-4d6e-b479-2653d31bffde</MessageKey>
    <ResponseMessage>sample string 3</ResponseMessage>
    <Success>true</Success>
  </MarkMessageAsReadResponse>
  <MarkMessageAsReadResponse>
    <MessageKey>c12a59e9-2c83-4d6e-b479-2653d31bffde</MessageKey>
    <ResponseMessage>sample string 3</ResponseMessage>
    <Success>true</Success>
  </MarkMessageAsReadResponse>
</ArrayOfMarkMessageAsReadResponse>