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": "8d769ee3-4768-44df-9261-92cf88b0d6ab",
  "messageRouteRepresentation": {
    "messageRouteId": "8af10c49-10da-44de-850b-ff1320810ff7",
    "tenantId": "e3e890e3-9a11-4e30-9f2a-2040a423f602",
    "messageTypeId": "f2cb33fe-d81e-4f20-9e3a-c96b2158f8fa",
    "userId": "c47b3a4c-17bd-4cd5-a330-54972dd1d68a",
    "userGroupId": "c3121996-dad4-412d-b971-f1af576df485",
    "deviceId": "9b60d03c-b457-4140-8ac8-1281e25104c6",
    "deviceGroupId": "9850757d-c21d-46e2-89c5-25d8191d7731",
    "applicationId": "085f7f3c-2019-403e-9d3c-4435159ea1ac",
    "applicationVersionId": "44a9acd1-36cf-4f9c-b04c-d6d1032e70e4",
    "messageDestinationId": "9661af6a-44ca-4f97-a87c-8bc2de5c28c1",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-07-27T18:14:44.8658132+00:00",
    "updatedDateUtc": "2026-07-27T18:14:44.8658132+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "7e9d1b1b-6296-4fa2-8da0-1f0b51b23b1c",
    "messageDestinationTypeId": "f54349d3-9247-425f-94f8-4b9d95f651ef",
    "tenantId": "77340d26-cb9f-4bef-9c34-2fba6e706d95",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-07-27T18:14:44.8658132+00:00",
    "updatedDateUtc": "2026-07-27T18:14:44.8658132+00:00"
  },
  "createdDateUtc": "2026-07-27T18:14:44.8658132+00:00",
  "updatedDateUtc": "2026-07-27T18:14:44.8658132+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-07-27T18:14:44.8658132+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-27T18:14:44.8658132+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-07-27T18:14:44.8658132+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-07-27T18:14:44.8658132+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>7e9d1b1b-6296-4fa2-8da0-1f0b51b23b1c</MessageDestinationId>
    <MessageDestinationTypeId>f54349d3-9247-425f-94f8-4b9d95f651ef</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>77340d26-cb9f-4bef-9c34-2fba6e706d95</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-07-27T18:14:44.8658132+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-07-27T18:14:44.8658132+00:00</UpdatedDateUtc>
    <ApplicationId>085f7f3c-2019-403e-9d3c-4435159ea1ac</ApplicationId>
    <ApplicationVersionId>44a9acd1-36cf-4f9c-b04c-d6d1032e70e4</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>9850757d-c21d-46e2-89c5-25d8191d7731</DeviceGroupId>
    <DeviceId>9b60d03c-b457-4140-8ac8-1281e25104c6</DeviceId>
    <MessageDestinationId>9661af6a-44ca-4f97-a87c-8bc2de5c28c1</MessageDestinationId>
    <MessageRouteId>8af10c49-10da-44de-850b-ff1320810ff7</MessageRouteId>
    <MessageTypeId>f2cb33fe-d81e-4f20-9e3a-c96b2158f8fa</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>e3e890e3-9a11-4e30-9f2a-2040a423f602</TenantId>
    <UserGroupId>c3121996-dad4-412d-b971-f1af576df485</UserGroupId>
    <UserId>c47b3a4c-17bd-4cd5-a330-54972dd1d68a</UserId>
  </MessageRouteRepresentation>
  <TenantId>8d769ee3-4768-44df-9261-92cf88b0d6ab</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.