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": "4ba95c15-5c87-4093-86db-9a413607fb3b",
  "messageRouteRepresentation": {
    "messageRouteId": "f9c7db2e-a21f-416c-97bc-efcfc4e23ac8",
    "tenantId": "7222e8c5-33c3-458d-8119-04d58bb199d0",
    "messageTypeId": "811216f5-89da-4d96-b8f5-03ad5f15b842",
    "userId": "f8598fe1-b7fe-4c98-a1a3-871880474b6b",
    "userGroupId": "e90544c5-da46-44ef-a6c6-23e13a06550b",
    "deviceId": "f6eedac9-9215-441e-84d6-0b5c4eb1fcc2",
    "deviceGroupId": "e24eac27-b017-401e-acd2-7a1750c155d2",
    "applicationId": "fec0121f-a3d5-47a9-aae4-ab987804d064",
    "applicationVersionId": "e54f97c3-12c3-4924-8951-a7485d6cd9b8",
    "messageDestinationId": "c7c77132-b2de-4f71-8a36-e9d424ddabd6",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-05-09T20:55:03.1402082+00:00",
    "updatedDateUtc": "2026-05-09T20:55:03.1402082+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "8d8ec8c1-ace9-4712-85a4-e83fe7beddf7",
    "messageDestinationTypeId": "572b51c9-5389-416f-a7bd-8b5ccb2a5874",
    "tenantId": "edce795a-b32c-4ddd-a0d1-ec7c9713c375",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-05-09T20:55:03.1402082+00:00",
    "updatedDateUtc": "2026-05-09T20:55:03.1402082+00:00"
  },
  "createdDateUtc": "2026-05-09T20:55:03.1402082+00:00",
  "updatedDateUtc": "2026-05-09T20:55:03.1402082+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-05-09T20:55:03.1402082+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-05-09T20:55:03.1402082+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-05-09T20:55:03.1402082+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-05-09T20:55:03.1402082+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>8d8ec8c1-ace9-4712-85a4-e83fe7beddf7</MessageDestinationId>
    <MessageDestinationTypeId>572b51c9-5389-416f-a7bd-8b5ccb2a5874</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>edce795a-b32c-4ddd-a0d1-ec7c9713c375</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-05-09T20:55:03.1402082+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-05-09T20:55:03.1402082+00:00</UpdatedDateUtc>
    <ApplicationId>fec0121f-a3d5-47a9-aae4-ab987804d064</ApplicationId>
    <ApplicationVersionId>e54f97c3-12c3-4924-8951-a7485d6cd9b8</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>e24eac27-b017-401e-acd2-7a1750c155d2</DeviceGroupId>
    <DeviceId>f6eedac9-9215-441e-84d6-0b5c4eb1fcc2</DeviceId>
    <MessageDestinationId>c7c77132-b2de-4f71-8a36-e9d424ddabd6</MessageDestinationId>
    <MessageRouteId>f9c7db2e-a21f-416c-97bc-efcfc4e23ac8</MessageRouteId>
    <MessageTypeId>811216f5-89da-4d96-b8f5-03ad5f15b842</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>7222e8c5-33c3-458d-8119-04d58bb199d0</TenantId>
    <UserGroupId>e90544c5-da46-44ef-a6c6-23e13a06550b</UserGroupId>
    <UserId>f8598fe1-b7fe-4c98-a1a3-871880474b6b</UserId>
  </MessageRouteRepresentation>
  <TenantId>4ba95c15-5c87-4093-86db-9a413607fb3b</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.