Cyan Web API - Version 1


POST api/messages

            Creates (and submits) a Message for processing.
            

Request Information

Parameters

NameDescriptionAdditional information
messageRepresentation
The message to submit for processing.
            
            The TenantId should be set to the TenantId for the request.  If not set, it will populated from the Tenant specified on the request header.

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:
{
  "messageId": "54c8c288-c3eb-4e51-bbac-41856b50c22c",
  "tenantId": "15ca5f5c-3158-45d8-b26c-d64db939412a",
  "messageTypeId": "a5569ebb-41f0-4af3-a1ab-22103bc8a6af",
  "messageTypeLookupKey": "sample string 4",
  "userId": "2d55eaa8-cb89-43f4-bf11-ccd5ea64c672",
  "userGroupId": "18f0087d-0ad5-4b37-9f02-eba04aeb254c",
  "deviceId": "6fb5aaba-d69e-46ee-b057-94bec0389701",
  "deviceGroupId": "724ecc95-f44e-4c9e-b984-d885cabbafa3",
  "applicationId": "a50c21f1-ced3-4dc7-bf0b-aa8465cd9695",
  "applicationVersionId": "4603914c-42ca-40d5-b5c6-e8505487ce17",
  "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": "7ba58917-a753-455f-b196-a7ed2d57c4ea",
  "messageAuditMessageAuditTypeId": "be112cf6-8cfd-47ec-942a-f73f5e0f5480",
  "messageAuditMessageAuditTypeName": "sample string 14",
  "messageAuditMessageAuditTypeLookupKey": "sample string 15",
  "messageAuditText": "sample string 16",
  "messageAuditCreatedDateUtc": "2025-04-19T15:42:32.8511376+00:00",
  "messageAuditUpdatedDateUtc": "2025-04-19T15:42:32.8511376+00:00",
  "cyanId": 18,
  "messageAuditCyanId": 1,
  "resubmitCount": 19,
  "createdDateUtc": "2025-04-19T15:42:32.8511376+00:00",
  "updatedDateUtc": "2025-04-19T15:42:32.8511376+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>2025-04-19T15:42:32.8511376+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-19T15:42:32.8511376+00:00</UpdatedDateUtc>
  <ApplicationId>a50c21f1-ced3-4dc7-bf0b-aa8465cd9695</ApplicationId>
  <ApplicationVersionId>4603914c-42ca-40d5-b5c6-e8505487ce17</ApplicationVersionId>
  <Body>sample string 9</Body>
  <CyanId>18</CyanId>
  <DeviceGroupId>724ecc95-f44e-4c9e-b984-d885cabbafa3</DeviceGroupId>
  <DeviceId>6fb5aaba-d69e-46ee-b057-94bec0389701</DeviceId>
  <MessageAuditCreatedDateUtc>2025-04-19T15:42:32.8511376+00:00</MessageAuditCreatedDateUtc>
  <MessageAuditCyanId>1</MessageAuditCyanId>
  <MessageAuditId>7ba58917-a753-455f-b196-a7ed2d57c4ea</MessageAuditId>
  <MessageAuditMessageAuditTypeId>be112cf6-8cfd-47ec-942a-f73f5e0f5480</MessageAuditMessageAuditTypeId>
  <MessageAuditMessageAuditTypeLookupKey>sample string 15</MessageAuditMessageAuditTypeLookupKey>
  <MessageAuditMessageAuditTypeName>sample string 14</MessageAuditMessageAuditTypeName>
  <MessageAuditText>sample string 16</MessageAuditText>
  <MessageAuditUpdatedDateUtc>2025-04-19T15:42:32.8511376+00:00</MessageAuditUpdatedDateUtc>
  <MessageId>54c8c288-c3eb-4e51-bbac-41856b50c22c</MessageId>
  <MessageTypeId>a5569ebb-41f0-4af3-a1ab-22103bc8a6af</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>15ca5f5c-3158-45d8-b26c-d64db939412a</TenantId>
  <UserGroupId>18f0087d-0ad5-4b37-9f02-eba04aeb254c</UserGroupId>
  <UserId>2d55eaa8-cb89-43f4-bf11-ccd5ea64c672</UserId>
</MessageRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.