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": "553906eb-bacc-4a32-a698-35bba9ba7c23",
  "messageRouteRepresentation": {
    "messageRouteId": "e6490c2c-74d9-4bc9-872c-6f4cdbbd0e6e",
    "tenantId": "e7ec3d11-a286-4d52-9c91-483338d5d3ae",
    "messageTypeId": "2cc6414b-0e72-45a3-b5e2-cc381db2581c",
    "userId": "780fb502-3d86-45ef-8a91-20cbfb24ac55",
    "userGroupId": "0e45cc5f-6e59-4835-876c-5879b975e85a",
    "deviceId": "21bfd0cc-34f2-414e-a281-3975f3885c90",
    "deviceGroupId": "df04b37f-ed45-4c3c-8646-6090f3d9edca",
    "applicationId": "1e7fe5a4-ce06-4852-9f02-6179bb947732",
    "applicationVersionId": "45d53c93-e005-4b7c-b60b-3d486a8b943d",
    "messageDestinationId": "8f10eb0d-d603-4c11-80b2-adc4159deeea",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-09-23T03:33:45.0030523+00:00",
    "updatedDateUtc": "2026-09-23T03:33:45.0030523+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "258ccc9c-eabf-4442-9db4-4a6b649c8aeb",
    "messageDestinationTypeId": "d1ef478a-fe35-4cd3-9767-4c2b6b958e51",
    "tenantId": "221b35d3-fa1d-45e8-a0f3-15324013e9c4",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-09-23T03:33:45.0030523+00:00",
    "updatedDateUtc": "2026-09-23T03:33:45.0030523+00:00"
  },
  "createdDateUtc": "2026-09-23T03:33:45.0030523+00:00",
  "updatedDateUtc": "2026-09-23T03:33:45.0030523+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-09-23T03:33:45.0030523+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-23T03:33:45.0030523+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-09-23T03:33:45.0030523+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-09-23T03:33:45.0030523+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>258ccc9c-eabf-4442-9db4-4a6b649c8aeb</MessageDestinationId>
    <MessageDestinationTypeId>d1ef478a-fe35-4cd3-9767-4c2b6b958e51</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>221b35d3-fa1d-45e8-a0f3-15324013e9c4</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-09-23T03:33:45.0030523+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-09-23T03:33:45.0030523+00:00</UpdatedDateUtc>
    <ApplicationId>1e7fe5a4-ce06-4852-9f02-6179bb947732</ApplicationId>
    <ApplicationVersionId>45d53c93-e005-4b7c-b60b-3d486a8b943d</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>df04b37f-ed45-4c3c-8646-6090f3d9edca</DeviceGroupId>
    <DeviceId>21bfd0cc-34f2-414e-a281-3975f3885c90</DeviceId>
    <MessageDestinationId>8f10eb0d-d603-4c11-80b2-adc4159deeea</MessageDestinationId>
    <MessageRouteId>e6490c2c-74d9-4bc9-872c-6f4cdbbd0e6e</MessageRouteId>
    <MessageTypeId>2cc6414b-0e72-45a3-b5e2-cc381db2581c</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>e7ec3d11-a286-4d52-9c91-483338d5d3ae</TenantId>
    <UserGroupId>0e45cc5f-6e59-4835-876c-5879b975e85a</UserGroupId>
    <UserId>780fb502-3d86-45ef-8a91-20cbfb24ac55</UserId>
  </MessageRouteRepresentation>
  <TenantId>553906eb-bacc-4a32-a698-35bba9ba7c23</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'.