POST GetMessages/{flagAsViewed}

Request Information

URI Parameters

Name	Description	Type	Additional information
flagAsViewed		string	Required

Body Parameters

QueryCriteria

Name	Type	Additional information
startDate	date	None.
endDate	date	None.
isViewed	boolean	None.
includeArchived	boolean	None.
customIdentifier1	Collection of string	None.
customIdentifier2	Collection of string	None.
customIdentifier3	Collection of string	None.
customIdentifier4	Collection of string	None.
organizationIds	Collection of integer	None.
userIds	Collection of integer	None.
messageIds	Collection of integer	None.
conversationKey	string	None.
maxMessageCountToReturn	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "startDate": "2026-01-26T18:17:11.4887512-07:00",
  "endDate": "2026-01-26T18:17:11.4887512-07:00",
  "isViewed": true,
  "includeArchived": true,
  "customIdentifier1": [
    "sample string 1",
    "sample string 2"
  ],
  "customIdentifier2": [
    "sample string 1",
    "sample string 2"
  ],
  "customIdentifier3": [
    "sample string 1",
    "sample string 2"
  ],
  "customIdentifier4": [
    "sample string 1",
    "sample string 2"
  ],
  "organizationIds": [
    1,
    2
  ],
  "userIds": [
    1,
    2
  ],
  "messageIds": [
    1,
    2
  ],
  "conversationKey": "sample string 1",
  "maxMessageCountToReturn": 1
}

application/xml, text/xml

Sample:

<QueryCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SecureMessagingAPI.Controllers">
  <conversationKey>sample string 1</conversationKey>
  <customIdentifier1 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </customIdentifier1>
  <customIdentifier2 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </customIdentifier2>
  <customIdentifier3 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </customIdentifier3>
  <customIdentifier4 xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </customIdentifier4>
  <endDate>2026-01-26T18:17:11.4887512-07:00</endDate>
  <includeArchived>true</includeArchived>
  <isViewed>true</isViewed>
  <maxMessageCountToReturn>1</maxMessageCountToReturn>
  <messageIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </messageIds>
  <organizationIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </organizationIds>
  <startDate>2026-01-26T18:17:11.4887512-07:00</startDate>
  <userIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </userIds>
</QueryCriteria>

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.