Cyan Web API - Version 1

POST api/messageRoute

            Creates a message route with a destination. A new destination will be created if a messageDestinationId is not passed in

Request Information

Parameters

Name	Description	Additional information
messageRouteDestinationRepresentation	- The TenantId field is required, and should match the tenant on the HTTP request header. - MessageRouteRepresentation -- MessageTypeId (Guid?) -- UserId (Guid?) -- UserGroupId (Guid?) -- DeviceId (Guid?) -- DeviceGroupId (Guid?) -- ApplicationId (Guid?) -- ApplicationVersionId (Guid?) -- MessageDestinationId (Guid) -- Name -- Description - MessageDestinationRepresentation -- MessageDestinationId (Guid) pass in if using an existing destination -- MessageDestinationTypeId (Guid) -- Name -- Description -- Address	Define this parameter in the request body.

Name

Description

Additional information

messageRouteDestinationRepresentation

- The TenantId field is required, and should match the tenant on the HTTP request header.
            - MessageRouteRepresentation
            -- MessageTypeId (Guid?)
            -- UserId (Guid?)
            -- UserGroupId (Guid?)
            -- DeviceId (Guid?)
            -- DeviceGroupId (Guid?)
            -- ApplicationId (Guid?)
            -- ApplicationVersionId (Guid?)
            -- MessageDestinationId (Guid)
            -- Name
            -- Description
            - MessageDestinationRepresentation
            -- MessageDestinationId (Guid) pass in if using an existing destination
            -- MessageDestinationTypeId (Guid)
            -- Name
            -- Description
            -- Address

Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "tenantId": "2ef33f13-25df-4836-accb-e4c2ecadc1e5",
  "messageRouteRepresentation": {
    "messageRouteId": "17b163cb-4570-4aa8-af91-fe92cc2fbe38",
    "tenantId": "aa166ed8-2099-4635-8a6c-91992b51d5e5",
    "messageTypeId": "2bde8e8d-f33b-4ea9-bf99-9d610c4807b3",
    "userId": "4b4c8072-9f91-41c4-85ce-934fd9c227fa",
    "userGroupId": "10f51f32-384a-4440-959b-0e11d3f356a9",
    "deviceId": "25c2234b-247c-4943-b7d2-64a79831b3ab",
    "deviceGroupId": "444d1d9c-ae50-4352-b33d-e2a67146e50d",
    "applicationId": "a33409c1-80f7-4fed-8860-e98782d12778",
    "applicationVersionId": "bbebaec2-24d2-4632-a071-f23c2bc2022e",
    "messageDestinationId": "8030affb-c735-4a98-a217-7e5669256d62",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-04-28T12:07:52.6786556+00:00",
    "updatedDateUtc": "2026-04-28T12:07:52.6786556+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "dfe852bf-22dd-43ff-8741-c9f2a3205ea1",
    "messageDestinationTypeId": "7d238bc1-d423-4dc3-9e8b-80e8a0230afd",
    "tenantId": "2c77353f-9a99-4a4c-8c54-2b3f18203e1e",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-04-28T12:07:52.6786556+00:00",
    "updatedDateUtc": "2026-04-28T12:07:52.6786556+00:00"
  },
  "createdDateUtc": "2026-04-28T12:07:52.6786556+00:00",
  "updatedDateUtc": "2026-04-28T12:07:52.6786556+00:00"
}

application/xml, text/xml

Sample:

<MessageRouteDestinationRepresentation 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-04-28T12:07:52.6786556+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-28T12:07:52.6786556+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-04-28T12:07:52.6786556+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-28T12:07:52.6786556+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>dfe852bf-22dd-43ff-8741-c9f2a3205ea1</MessageDestinationId>
    <MessageDestinationTypeId>7d238bc1-d423-4dc3-9e8b-80e8a0230afd</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>2c77353f-9a99-4a4c-8c54-2b3f18203e1e</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-04-28T12:07:52.6786556+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-28T12:07:52.6786556+00:00</UpdatedDateUtc>
    <ApplicationId>a33409c1-80f7-4fed-8860-e98782d12778</ApplicationId>
    <ApplicationVersionId>bbebaec2-24d2-4632-a071-f23c2bc2022e</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>444d1d9c-ae50-4352-b33d-e2a67146e50d</DeviceGroupId>
    <DeviceId>25c2234b-247c-4943-b7d2-64a79831b3ab</DeviceId>
    <MessageDestinationId>8030affb-c735-4a98-a217-7e5669256d62</MessageDestinationId>
    <MessageRouteId>17b163cb-4570-4aa8-af91-fe92cc2fbe38</MessageRouteId>
    <MessageTypeId>2bde8e8d-f33b-4ea9-bf99-9d610c4807b3</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>aa166ed8-2099-4635-8a6c-91992b51d5e5</TenantId>
    <UserGroupId>10f51f32-384a-4440-959b-0e11d3f356a9</UserGroupId>
    <UserId>4b4c8072-9f91-41c4-85ce-934fd9c227fa</UserId>
  </MessageRouteRepresentation>
  <TenantId>2ef33f13-25df-4836-accb-e4c2ecadc1e5</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.