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": "e0f5cd2f-6d43-4b37-b0d0-dcef38f3161d",
  "messageRouteRepresentation": {
    "messageRouteId": "70c3fb26-21dc-49bf-909a-07ac21cd6889",
    "tenantId": "17be68a0-9de8-4661-a806-25302d34ac74",
    "messageTypeId": "0dfe1388-9e01-4db3-8f44-64e4f90966bb",
    "userId": "1167618f-66af-4d5d-a221-d37f5a48d8cf",
    "userGroupId": "17313f1a-7d44-407e-943a-8e6b8feeb3fb",
    "deviceId": "bf8a1132-a189-41f9-ad50-93bba91c6f73",
    "deviceGroupId": "b3683c55-2dee-4d3e-9ef0-ff46f8509981",
    "applicationId": "f1c8c08d-ea0a-4397-bed2-adb2762ea576",
    "applicationVersionId": "0593e18e-c0a4-4bc2-8e68-3514708385b8",
    "messageDestinationId": "e2c9e0db-f090-474d-9e6f-e55ca8645091",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-06-05T18:16:34.1682875+00:00",
    "updatedDateUtc": "2026-06-05T18:16:34.1682875+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "ee27846b-f36a-4d41-82c2-94baff7d1e89",
    "messageDestinationTypeId": "6ea8bdbd-75fa-48cf-8d9a-7334b231d667",
    "tenantId": "905a61e0-16eb-4b27-ad28-cf0b0adf12d3",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-06-05T18:16:34.1682875+00:00",
    "updatedDateUtc": "2026-06-05T18:16:34.1682875+00:00"
  },
  "createdDateUtc": "2026-06-05T18:16:34.1682875+00:00",
  "updatedDateUtc": "2026-06-05T18:16:34.1682875+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-06-05T18:16:34.1682875+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-05T18:16:34.1682875+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-06-05T18:16:34.1682875+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-06-05T18:16:34.1682875+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>ee27846b-f36a-4d41-82c2-94baff7d1e89</MessageDestinationId>
    <MessageDestinationTypeId>6ea8bdbd-75fa-48cf-8d9a-7334b231d667</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>905a61e0-16eb-4b27-ad28-cf0b0adf12d3</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-06-05T18:16:34.1682875+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-06-05T18:16:34.1682875+00:00</UpdatedDateUtc>
    <ApplicationId>f1c8c08d-ea0a-4397-bed2-adb2762ea576</ApplicationId>
    <ApplicationVersionId>0593e18e-c0a4-4bc2-8e68-3514708385b8</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>b3683c55-2dee-4d3e-9ef0-ff46f8509981</DeviceGroupId>
    <DeviceId>bf8a1132-a189-41f9-ad50-93bba91c6f73</DeviceId>
    <MessageDestinationId>e2c9e0db-f090-474d-9e6f-e55ca8645091</MessageDestinationId>
    <MessageRouteId>70c3fb26-21dc-49bf-909a-07ac21cd6889</MessageRouteId>
    <MessageTypeId>0dfe1388-9e01-4db3-8f44-64e4f90966bb</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>17be68a0-9de8-4661-a806-25302d34ac74</TenantId>
    <UserGroupId>17313f1a-7d44-407e-943a-8e6b8feeb3fb</UserGroupId>
    <UserId>1167618f-66af-4d5d-a221-d37f5a48d8cf</UserId>
  </MessageRouteRepresentation>
  <TenantId>e0f5cd2f-6d43-4b37-b0d0-dcef38f3161d</TenantId>
</MessageRouteDestinationRepresentation>

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 'MessageRouteDestinationRepresentation'.