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": "3c37bb0b-3e65-4fc2-a0eb-60a69d4b0964",
  "messageRouteRepresentation": {
    "messageRouteId": "63b4cca8-b005-47be-8095-6411e9629dbd",
    "tenantId": "9dec76e4-d610-4da0-b91c-a0fdaa441ee9",
    "messageTypeId": "b4a14622-c1ff-428d-b6fd-87c59f5fbe18",
    "userId": "21ab3975-ab69-463e-a102-7581b59cae3d",
    "userGroupId": "09dfc4fd-4fab-40fa-9c3b-1155d1c66e3e",
    "deviceId": "cba46fff-2cb8-4275-a520-c3330e16f666",
    "deviceGroupId": "dbb56c81-d9f9-4aa5-8226-da9864b0a055",
    "applicationId": "6b1bedf4-22aa-4bc1-90f7-73e5d7f20877",
    "applicationVersionId": "4af86f95-ebe5-4fe0-9ffa-aeb9ddbf5744",
    "messageDestinationId": "65e10f3a-2c31-42b4-a4ab-5df1ea94a6ca",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-03-14T10:36:28.1138421+00:00",
    "updatedDateUtc": "2026-03-14T10:36:28.1138421+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "b589356c-5d0d-4f55-b6f1-dcba7060a8a4",
    "messageDestinationTypeId": "d7cbb8fb-62e4-4505-ba59-7c341371d23e",
    "tenantId": "26fc670f-9129-4ab9-984b-bae2c36f75d9",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-03-14T10:36:28.1138421+00:00",
    "updatedDateUtc": "2026-03-14T10:36:28.1138421+00:00"
  },
  "createdDateUtc": "2026-03-14T10:36:28.1138421+00:00",
  "updatedDateUtc": "2026-03-14T10:36:28.1138421+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-03-14T10:36:28.1138421+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-14T10:36:28.1138421+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-03-14T10:36:28.1138421+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T10:36:28.1138421+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>b589356c-5d0d-4f55-b6f1-dcba7060a8a4</MessageDestinationId>
    <MessageDestinationTypeId>d7cbb8fb-62e4-4505-ba59-7c341371d23e</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>26fc670f-9129-4ab9-984b-bae2c36f75d9</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-03-14T10:36:28.1138421+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-14T10:36:28.1138421+00:00</UpdatedDateUtc>
    <ApplicationId>6b1bedf4-22aa-4bc1-90f7-73e5d7f20877</ApplicationId>
    <ApplicationVersionId>4af86f95-ebe5-4fe0-9ffa-aeb9ddbf5744</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>dbb56c81-d9f9-4aa5-8226-da9864b0a055</DeviceGroupId>
    <DeviceId>cba46fff-2cb8-4275-a520-c3330e16f666</DeviceId>
    <MessageDestinationId>65e10f3a-2c31-42b4-a4ab-5df1ea94a6ca</MessageDestinationId>
    <MessageRouteId>63b4cca8-b005-47be-8095-6411e9629dbd</MessageRouteId>
    <MessageTypeId>b4a14622-c1ff-428d-b6fd-87c59f5fbe18</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>9dec76e4-d610-4da0-b91c-a0fdaa441ee9</TenantId>
    <UserGroupId>09dfc4fd-4fab-40fa-9c3b-1155d1c66e3e</UserGroupId>
    <UserId>21ab3975-ab69-463e-a102-7581b59cae3d</UserId>
  </MessageRouteRepresentation>
  <TenantId>3c37bb0b-3e65-4fc2-a0eb-60a69d4b0964</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'.