PUT restapi/personal/messages/v1

Updates messages.

Only supports updating the IsRead field of each Message.

Will return 404 if none of the messageIds are found, or the user does not have access to any.

Request Information

URI Parameters

None.

Body Parameters

The messages to update

Collection of Itslearning.RestApi.Entities.Updatable.MessageUpdateV1

Name	Description	Type	Additional information
MessageId	The MessageId	integer	None.
IsRead	Whether the message has been read	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "MessageId": 1,
    "IsRead": true
  },
  {
    "MessageId": 1,
    "IsRead": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfMessageUpdateV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Itslearning.RestApi.Entities.Updatable">
  <MessageUpdateV1>
    <IsRead>true</IsRead>
    <MessageId>1</MessageId>
  </MessageUpdateV1>
  <MessageUpdateV1>
    <IsRead>true</IsRead>
    <MessageId>1</MessageId>
  </MessageUpdateV1>
</ArrayOfMessageUpdateV1>

application/x-www-form-urlencoded

Sample:

No sample available

Response Information

Resource Description

List of modified MessagePreview entities that were updated. Messages that were not updated (e.g. not found), will not be returned in response

EntityListOfItslearning.RestApi.Entities.MessagePreview

Name	Type	Additional information
EntityArray	Collection of Itslearning.RestApi.Entities.MessagePreview	None.
Total	integer	None.
CurrentPageIndex	integer	None.
PageSize	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "EntityArray": [
    {
      "MessageId": 1,
      "From": {
        "PersonId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "FullName": "sample string 4",
        "ProfileUrl": "sample string 5",
        "AdditionalInfo": "sample string 6",
        "ProfileImageUrl": "sample string 7",
        "ProfileImageUrlSmall": "sample string 8"
      },
      "DateReceived": "2025-06-25T14:40:37Z",
      "Subject": "sample string 3",
      "PreviewText": "sample string 4",
      "MessageUrl": "sample string 5",
      "ContentUrl": "sample string 6",
      "HasAttachments": true,
      "IsRead": true,
      "IsForwarded": true,
      "LastForwardedDateTime": "2025-06-25T14:40:37Z",
      "IsReplied": true,
      "LastRepliedDateTime": "2025-06-25T14:40:37Z"
    },
    {
      "MessageId": 1,
      "From": {
        "PersonId": 1,
        "FirstName": "sample string 2",
        "LastName": "sample string 3",
        "FullName": "sample string 4",
        "ProfileUrl": "sample string 5",
        "AdditionalInfo": "sample string 6",
        "ProfileImageUrl": "sample string 7",
        "ProfileImageUrlSmall": "sample string 8"
      },
      "DateReceived": "2025-06-25T14:40:37Z",
      "Subject": "sample string 3",
      "PreviewText": "sample string 4",
      "MessageUrl": "sample string 5",
      "ContentUrl": "sample string 6",
      "HasAttachments": true,
      "IsRead": true,
      "IsForwarded": true,
      "LastForwardedDateTime": "2025-06-25T14:40:37Z",
      "IsReplied": true,
      "LastRepliedDateTime": "2025-06-25T14:40:37Z"
    }
  ],
  "Total": 1,
  "CurrentPageIndex": 2,
  "PageSize": 3
}

application/xml, text/xml

Sample:

<EntityList xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <CurrentPageIndex>2</CurrentPageIndex>
  <EntityArray>
    <MessagePreview>
      <ContentUrl>sample string 6</ContentUrl>
      <DateReceived>2025-06-25T14:40:37Z</DateReceived>
      <From>
        <AdditionalInfo>sample string 6</AdditionalInfo>
        <FirstName>sample string 2</FirstName>
        <FullName>sample string 4</FullName>
        <LastName>sample string 3</LastName>
        <PersonId>1</PersonId>
        <ProfileImageUrl>sample string 7</ProfileImageUrl>
        <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
        <ProfileUrl>sample string 5</ProfileUrl>
      </From>
      <HasAttachments>true</HasAttachments>
      <IsForwarded>true</IsForwarded>
      <IsRead>true</IsRead>
      <IsReplied>true</IsReplied>
      <LastForwardedDateTime>2025-06-25T14:40:37Z</LastForwardedDateTime>
      <LastRepliedDateTime>2025-06-25T14:40:37Z</LastRepliedDateTime>
      <MessageId>1</MessageId>
      <MessageUrl>sample string 5</MessageUrl>
      <PreviewText>sample string 4</PreviewText>
      <Subject>sample string 3</Subject>
    </MessagePreview>
    <MessagePreview>
      <ContentUrl>sample string 6</ContentUrl>
      <DateReceived>2025-06-25T14:40:37Z</DateReceived>
      <From>
        <AdditionalInfo>sample string 6</AdditionalInfo>
        <FirstName>sample string 2</FirstName>
        <FullName>sample string 4</FullName>
        <LastName>sample string 3</LastName>
        <PersonId>1</PersonId>
        <ProfileImageUrl>sample string 7</ProfileImageUrl>
        <ProfileImageUrlSmall>sample string 8</ProfileImageUrlSmall>
        <ProfileUrl>sample string 5</ProfileUrl>
      </From>
      <HasAttachments>true</HasAttachments>
      <IsForwarded>true</IsForwarded>
      <IsRead>true</IsRead>
      <IsReplied>true</IsReplied>
      <LastForwardedDateTime>2025-06-25T14:40:37Z</LastForwardedDateTime>
      <LastRepliedDateTime>2025-06-25T14:40:37Z</LastRepliedDateTime>
      <MessageId>1</MessageId>
      <MessageUrl>sample string 5</MessageUrl>
      <PreviewText>sample string 4</PreviewText>
      <Subject>sample string 3</Subject>
    </MessagePreview>
  </EntityArray>
  <PageSize>3</PageSize>
  <Total>1</Total>
</EntityList>