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": "71f32ab4-2185-4766-9483-a3a27d2197d3",
  "messageRouteRepresentation": {
    "messageRouteId": "e9be4080-c58a-4020-ab2b-e4c8dda409a8",
    "tenantId": "0625b58c-fa69-4e19-bd5f-1b3055a538a0",
    "messageTypeId": "33a8a2f4-8145-4a91-a1b3-3e32068b3a35",
    "userId": "32eb0b5b-acfd-42d9-968b-f89c3cca9558",
    "userGroupId": "007521b8-9b09-4262-b5e7-0a5dec551a9f",
    "deviceId": "a4e0bcab-2c0b-4d0d-a65a-931925be38ee",
    "deviceGroupId": "1eafdfcd-5d19-4059-a2a9-05ec5c887f29",
    "applicationId": "566be6a8-8d67-4661-ad39-fb6a41ac8b30",
    "applicationVersionId": "aadd90a1-ae94-4fd3-9ae9-d8d58919bf43",
    "messageDestinationId": "2cf78a1d-5130-436d-9c06-21b45cceb82b",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-04-05T06:02:27.9737635+00:00",
    "updatedDateUtc": "2026-04-05T06:02:27.9737635+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "edd9e16d-dbe8-4942-a047-5a495430678d",
    "messageDestinationTypeId": "66c1a3fe-fc0b-4cd4-8923-e83cb91fb288",
    "tenantId": "4222ac0c-122f-41bd-b0af-8b8fe3648f89",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-04-05T06:02:27.9737635+00:00",
    "updatedDateUtc": "2026-04-05T06:02:27.9737635+00:00"
  },
  "createdDateUtc": "2026-04-05T06:02:27.9737635+00:00",
  "updatedDateUtc": "2026-04-05T06:02:27.9737635+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-05T06:02:27.9737635+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-05T06:02:27.9737635+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-04-05T06:02:27.9737635+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-05T06:02:27.9737635+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>edd9e16d-dbe8-4942-a047-5a495430678d</MessageDestinationId>
    <MessageDestinationTypeId>66c1a3fe-fc0b-4cd4-8923-e83cb91fb288</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>4222ac0c-122f-41bd-b0af-8b8fe3648f89</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-04-05T06:02:27.9737635+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-05T06:02:27.9737635+00:00</UpdatedDateUtc>
    <ApplicationId>566be6a8-8d67-4661-ad39-fb6a41ac8b30</ApplicationId>
    <ApplicationVersionId>aadd90a1-ae94-4fd3-9ae9-d8d58919bf43</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>1eafdfcd-5d19-4059-a2a9-05ec5c887f29</DeviceGroupId>
    <DeviceId>a4e0bcab-2c0b-4d0d-a65a-931925be38ee</DeviceId>
    <MessageDestinationId>2cf78a1d-5130-436d-9c06-21b45cceb82b</MessageDestinationId>
    <MessageRouteId>e9be4080-c58a-4020-ab2b-e4c8dda409a8</MessageRouteId>
    <MessageTypeId>33a8a2f4-8145-4a91-a1b3-3e32068b3a35</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>0625b58c-fa69-4e19-bd5f-1b3055a538a0</TenantId>
    <UserGroupId>007521b8-9b09-4262-b5e7-0a5dec551a9f</UserGroupId>
    <UserId>32eb0b5b-acfd-42d9-968b-f89c3cca9558</UserId>
  </MessageRouteRepresentation>
  <TenantId>71f32ab4-2185-4766-9483-a3a27d2197d3</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'.