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": "a64c1af5-7d9a-4747-a32d-0b4904de2d18",
  "messageRouteRepresentation": {
    "messageRouteId": "b9df4887-ee0c-4b94-af00-7f39bd969e72",
    "tenantId": "3fb58478-ee3f-4607-a2d1-acb0da2c03c0",
    "messageTypeId": "bb00307f-b363-4055-9e25-51b9433c45c0",
    "userId": "c277a85d-f3d5-4af3-b9ee-ca1b08e70371",
    "userGroupId": "bc02ae68-787f-4174-942e-a394d4dfb10d",
    "deviceId": "28872a88-5187-4c62-9390-3d0c0844f096",
    "deviceGroupId": "d685d204-6aab-463c-8e14-31e0ec98f0ee",
    "applicationId": "29dab1ca-b819-4fb7-87e9-9fdeb51bb081",
    "applicationVersionId": "a95b1e8b-cc42-4638-83bb-abb616c8f797",
    "messageDestinationId": "a0056aba-9bc4-4ddd-a7a1-97e1babe557a",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-03-14T07:23:41.1384247+00:00",
    "updatedDateUtc": "2026-03-14T07:23:41.1384247+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "dbc2b289-96bf-44a2-b653-b48c27b87443",
    "messageDestinationTypeId": "7a21ab51-a7b3-426d-907b-48f1d3e277cb",
    "tenantId": "8921ad21-d5d4-4490-9c85-0c2f38c688e7",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-03-14T07:23:41.1384247+00:00",
    "updatedDateUtc": "2026-03-14T07:23:41.1384247+00:00"
  },
  "createdDateUtc": "2026-03-14T07:23:41.1384247+00:00",
  "updatedDateUtc": "2026-03-14T07:23:41.1384247+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-03-14T07:23:41.1384247+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-14T07:23:41.1384247+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-03-14T07:23:41.1384247+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T07:23:41.1384247+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>dbc2b289-96bf-44a2-b653-b48c27b87443</MessageDestinationId>
    <MessageDestinationTypeId>7a21ab51-a7b3-426d-907b-48f1d3e277cb</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>8921ad21-d5d4-4490-9c85-0c2f38c688e7</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-03-14T07:23:41.1384247+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T07:23:41.1384247+00:00</UpdatedDateUtc>
    <ApplicationId>29dab1ca-b819-4fb7-87e9-9fdeb51bb081</ApplicationId>
    <ApplicationVersionId>a95b1e8b-cc42-4638-83bb-abb616c8f797</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>d685d204-6aab-463c-8e14-31e0ec98f0ee</DeviceGroupId>
    <DeviceId>28872a88-5187-4c62-9390-3d0c0844f096</DeviceId>
    <MessageDestinationId>a0056aba-9bc4-4ddd-a7a1-97e1babe557a</MessageDestinationId>
    <MessageRouteId>b9df4887-ee0c-4b94-af00-7f39bd969e72</MessageRouteId>
    <MessageTypeId>bb00307f-b363-4055-9e25-51b9433c45c0</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>3fb58478-ee3f-4607-a2d1-acb0da2c03c0</TenantId>
    <UserGroupId>bc02ae68-787f-4174-942e-a394d4dfb10d</UserGroupId>
    <UserId>c277a85d-f3d5-4af3-b9ee-ca1b08e70371</UserId>
  </MessageRouteRepresentation>
  <TenantId>a64c1af5-7d9a-4747-a32d-0b4904de2d18</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.