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": "9b535931-b908-4c93-ad4c-1323eb0ea30d",
  "messageRouteRepresentation": {
    "messageRouteId": "6954f344-5395-4777-aa0b-3f811ae2c1bd",
    "tenantId": "07da40f2-b625-4fb1-8575-ccdfc9475c15",
    "messageTypeId": "31c0b673-78a1-4f51-9fac-acc1b12341aa",
    "userId": "6c2de66b-6132-4ac7-93c5-3b4b97a33d7b",
    "userGroupId": "9e26f7fa-bee8-491a-9a1c-55e09bfc6635",
    "deviceId": "d956ee0e-e5c1-4ad5-86ec-94903ec0b269",
    "deviceGroupId": "68e04515-12ed-41c0-96af-6e35bbbec88a",
    "applicationId": "608f57d8-b461-454b-b98c-8492e20b4fe8",
    "applicationVersionId": "ecae24f0-cf56-4fd4-a5d3-a4e19d1b9e83",
    "messageDestinationId": "ec9c74b7-575b-4d56-90d0-2c4db444ae3c",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-10-07T16:33:23.3496989+00:00",
    "updatedDateUtc": "2026-10-07T16:33:23.3496989+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "9d4491a3-e8dc-4a7f-9c6f-761bef798874",
    "messageDestinationTypeId": "f19cde54-a0c7-42fc-a65c-35b4a2a7fdc2",
    "tenantId": "47e495f1-2622-4494-9b15-a73875a3c22a",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-10-07T16:33:23.3496989+00:00",
    "updatedDateUtc": "2026-10-07T16:33:23.3496989+00:00"
  },
  "createdDateUtc": "2026-10-07T16:33:23.3496989+00:00",
  "updatedDateUtc": "2026-10-07T16:33:23.3496989+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-10-07T16:33:23.3496989+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-10-07T16:33:23.3496989+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-10-07T16:33:23.3496989+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-10-07T16:33:23.3496989+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>9d4491a3-e8dc-4a7f-9c6f-761bef798874</MessageDestinationId>
    <MessageDestinationTypeId>f19cde54-a0c7-42fc-a65c-35b4a2a7fdc2</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>47e495f1-2622-4494-9b15-a73875a3c22a</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-10-07T16:33:23.3496989+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-10-07T16:33:23.3496989+00:00</UpdatedDateUtc>
    <ApplicationId>608f57d8-b461-454b-b98c-8492e20b4fe8</ApplicationId>
    <ApplicationVersionId>ecae24f0-cf56-4fd4-a5d3-a4e19d1b9e83</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>68e04515-12ed-41c0-96af-6e35bbbec88a</DeviceGroupId>
    <DeviceId>d956ee0e-e5c1-4ad5-86ec-94903ec0b269</DeviceId>
    <MessageDestinationId>ec9c74b7-575b-4d56-90d0-2c4db444ae3c</MessageDestinationId>
    <MessageRouteId>6954f344-5395-4777-aa0b-3f811ae2c1bd</MessageRouteId>
    <MessageTypeId>31c0b673-78a1-4f51-9fac-acc1b12341aa</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>07da40f2-b625-4fb1-8575-ccdfc9475c15</TenantId>
    <UserGroupId>9e26f7fa-bee8-491a-9a1c-55e09bfc6635</UserGroupId>
    <UserId>6c2de66b-6132-4ac7-93c5-3b4b97a33d7b</UserId>
  </MessageRouteRepresentation>
  <TenantId>9b535931-b908-4c93-ad4c-1323eb0ea30d</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.