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": "0cbc3542-9494-4815-9546-6de02370c2cd",
  "messageRouteRepresentation": {
    "messageRouteId": "aed0fc09-6363-46b4-96ce-711b9f07a5e9",
    "tenantId": "62346ff8-0cdb-48c2-9f38-045252222779",
    "messageTypeId": "cd2ae726-0f3d-4632-8514-725539a91952",
    "userId": "766ec132-a053-4662-bef2-30da51a4c4b5",
    "userGroupId": "b96f97d5-ed3d-4b01-bcfe-72defe663b3f",
    "deviceId": "b531a1eb-0c83-475b-ab93-a710fba58121",
    "deviceGroupId": "dc8554f4-8409-444f-b01d-4c8984930699",
    "applicationId": "bccce2eb-53c5-4afb-a59c-708a96fffc6b",
    "applicationVersionId": "870d288c-b342-4879-95ef-273c36056275",
    "messageDestinationId": "62441370-f31b-4d59-ad74-3ea285b85c1b",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-02-07T02:01:58.8530968+00:00",
    "updatedDateUtc": "2026-02-07T02:01:58.8530968+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "f127fb94-4516-4232-8182-0fbf75c5f2a5",
    "messageDestinationTypeId": "c2c0976f-c27c-4bf3-8c08-d8243c291590",
    "tenantId": "41081ca8-eee5-4ca7-9fcc-024bdf9b67ef",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-02-07T02:01:58.8530968+00:00",
    "updatedDateUtc": "2026-02-07T02:01:58.8530968+00:00"
  },
  "createdDateUtc": "2026-02-07T02:01:58.8530968+00:00",
  "updatedDateUtc": "2026-02-07T02:01:58.8530968+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-02-07T02:01:58.8530968+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-07T02:01:58.8530968+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-02-07T02:01:58.8530968+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-07T02:01:58.8530968+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>f127fb94-4516-4232-8182-0fbf75c5f2a5</MessageDestinationId>
    <MessageDestinationTypeId>c2c0976f-c27c-4bf3-8c08-d8243c291590</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>41081ca8-eee5-4ca7-9fcc-024bdf9b67ef</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-02-07T02:01:58.8530968+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-07T02:01:58.8530968+00:00</UpdatedDateUtc>
    <ApplicationId>bccce2eb-53c5-4afb-a59c-708a96fffc6b</ApplicationId>
    <ApplicationVersionId>870d288c-b342-4879-95ef-273c36056275</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>dc8554f4-8409-444f-b01d-4c8984930699</DeviceGroupId>
    <DeviceId>b531a1eb-0c83-475b-ab93-a710fba58121</DeviceId>
    <MessageDestinationId>62441370-f31b-4d59-ad74-3ea285b85c1b</MessageDestinationId>
    <MessageRouteId>aed0fc09-6363-46b4-96ce-711b9f07a5e9</MessageRouteId>
    <MessageTypeId>cd2ae726-0f3d-4632-8514-725539a91952</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>62346ff8-0cdb-48c2-9f38-045252222779</TenantId>
    <UserGroupId>b96f97d5-ed3d-4b01-bcfe-72defe663b3f</UserGroupId>
    <UserId>766ec132-a053-4662-bef2-30da51a4c4b5</UserId>
  </MessageRouteRepresentation>
  <TenantId>0cbc3542-9494-4815-9546-6de02370c2cd</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'.