Cyan Web API - Version 1

PUT api/messages/{messageId:guid}/body

            Updates the body of a message, but does not (re)submit the message.

Request Information

Parameters

Name	Description	Additional information
messageId	No documentation available.	Define this parameter in the request URI.
messageRepresentation	MessageRepresentation containing the new body to set	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "messageId": "bb8ff4d6-1837-4d5f-916e-f13981f9e790",
  "tenantId": "9dd3b807-1719-48c8-ae6a-1eabe6f137fd",
  "messageTypeId": "b5e7a21a-dfb6-4b86-8da0-dd5794c7af0b",
  "messageTypeLookupKey": "sample string 4",
  "userId": "15cb73c3-8274-42c3-8059-5dcb09c982c1",
  "userGroupId": "011e388a-1a65-4fce-bf0e-8d9172014b35",
  "deviceId": "3e8d89f7-494c-4125-a368-56a2791b861c",
  "deviceGroupId": "c56649cf-59dc-4276-9263-cc891215df78",
  "applicationId": "f4985fc9-19a4-4cb7-ac02-8810f45b59ed",
  "applicationVersionId": "7673999f-76fc-420a-b3b5-d2c3d79126a2",
  "senderSessionId": "sample string 5",
  "senderSessionSequence": 1,
  "senderCorrelationId": "sample string 6",
  "senderGroup": "sample string 7",
  "senderNote": "sample string 8",
  "body": "sample string 9",
  "storeEncryptedPassword": true,
  "storeHashedPassword": true,
  "messageAuditId": "a8708eb8-af11-4acc-8ec3-943603578057",
  "messageAuditMessageAuditTypeId": "aced7578-4e51-4998-9a53-7f391400078e",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2026-03-08T00:56:23.1800066+00:00",
  "messageAuditUpdatedDateUtc": "2026-03-08T00:56:23.1800066+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2026-03-08T00:56:23.1800066+00:00",
  "updatedDateUtc": "2026-03-08T00:56:23.1800066+00:00"
}

application/xml, text/xml

Sample:

<MessageRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2026-03-08T00:56:23.1800066+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-08T00:56:23.1800066+00:00</UpdatedDateUtc>
  <ApplicationId>f4985fc9-19a4-4cb7-ac02-8810f45b59ed</ApplicationId>
  <ApplicationVersionId>7673999f-76fc-420a-b3b5-d2c3d79126a2</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>c56649cf-59dc-4276-9263-cc891215df78</DeviceGroupId>
  <DeviceId>3e8d89f7-494c-4125-a368-56a2791b861c</DeviceId>
  <MessageAuditCreatedDateUtc>2026-03-08T00:56:23.1800066+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>a8708eb8-af11-4acc-8ec3-943603578057</MessageAuditId>
  <MessageAuditMessageAuditTypeId>aced7578-4e51-4998-9a53-7f391400078e</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2026-03-08T00:56:23.1800066+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>bb8ff4d6-1837-4d5f-916e-f13981f9e790</MessageId>
  <MessageTypeId>b5e7a21a-dfb6-4b86-8da0-dd5794c7af0b</MessageTypeId>
  <MessageTypeLookupKey>sample string 4</MessageTypeLookupKey>
  <ResubmitCount>19</ResubmitCount>
  <SenderCorrelationId>sample string 6</SenderCorrelationId>
  <SenderGroup>sample string 7</SenderGroup>
  <SenderNote>sample string 8</SenderNote>
  <SenderSessionId>sample string 5</SenderSessionId>
  <SenderSessionSequence>1</SenderSessionSequence>
  <StoreEncryptedPassword>true</StoreEncryptedPassword>
  <StoreHashedPassword>true</StoreHashedPassword>
  <TenantId>9dd3b807-1719-48c8-ae6a-1eabe6f137fd</TenantId>
  <UserGroupId>011e388a-1a65-4fce-bf0e-8d9172014b35</UserGroupId>
  <UserId>15cb73c3-8274-42c3-8059-5dcb09c982c1</UserId>
</MessageRepresentation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MessageRepresentation'.