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": "b37f392c-0a6a-4871-ae95-2774decbfc1d",
  "messageRouteRepresentation": {
    "messageRouteId": "5def459b-b959-4362-898f-c4c012913ffe",
    "tenantId": "39f1b700-90d3-42b2-a503-5e0be34bb3bd",
    "messageTypeId": "a0d73643-c468-43e9-9671-e293e1c67576",
    "userId": "1b1b7189-14b6-4c8d-9651-5ee037051aa1",
    "userGroupId": "b18fa5e0-b5de-4ec3-bc8a-269f2ff54fcf",
    "deviceId": "a5e5e80e-8408-4726-ae4f-12676691d018",
    "deviceGroupId": "2d1b2db8-1d94-4f70-9453-3fe8746643d0",
    "applicationId": "7486de64-b79f-4f25-af07-f4e8a5584c93",
    "applicationVersionId": "95405f13-a0b7-4283-95ca-364a367a50e1",
    "messageDestinationId": "f6473393-972a-4d2d-9df5-a83613424f9a",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-09-11T10:57:13.7803314+00:00",
    "updatedDateUtc": "2026-09-11T10:57:13.7803314+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "53c21a0a-b86f-4ed3-aa9b-5f569cb126a3",
    "messageDestinationTypeId": "7ea8fc93-138c-4cf2-8994-37212315b17b",
    "tenantId": "01694fe7-f040-405b-981c-7ed7e1a2abd9",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-09-11T10:57:13.7803314+00:00",
    "updatedDateUtc": "2026-09-11T10:57:13.7803314+00:00"
  },
  "createdDateUtc": "2026-09-11T10:57:13.7803314+00:00",
  "updatedDateUtc": "2026-09-11T10:57:13.7803314+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-11T10:57:13.7803314+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-09-11T10:57:13.7803314+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-09-11T10:57:13.7803314+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-09-11T10:57:13.7803314+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>53c21a0a-b86f-4ed3-aa9b-5f569cb126a3</MessageDestinationId>
    <MessageDestinationTypeId>7ea8fc93-138c-4cf2-8994-37212315b17b</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>01694fe7-f040-405b-981c-7ed7e1a2abd9</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-09-11T10:57:13.7803314+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-09-11T10:57:13.7803314+00:00</UpdatedDateUtc>
    <ApplicationId>7486de64-b79f-4f25-af07-f4e8a5584c93</ApplicationId>
    <ApplicationVersionId>95405f13-a0b7-4283-95ca-364a367a50e1</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>2d1b2db8-1d94-4f70-9453-3fe8746643d0</DeviceGroupId>
    <DeviceId>a5e5e80e-8408-4726-ae4f-12676691d018</DeviceId>
    <MessageDestinationId>f6473393-972a-4d2d-9df5-a83613424f9a</MessageDestinationId>
    <MessageRouteId>5def459b-b959-4362-898f-c4c012913ffe</MessageRouteId>
    <MessageTypeId>a0d73643-c468-43e9-9671-e293e1c67576</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>39f1b700-90d3-42b2-a503-5e0be34bb3bd</TenantId>
    <UserGroupId>b18fa5e0-b5de-4ec3-bc8a-269f2ff54fcf</UserGroupId>
    <UserId>1b1b7189-14b6-4c8d-9651-5ee037051aa1</UserId>
  </MessageRouteRepresentation>
  <TenantId>b37f392c-0a6a-4871-ae95-2774decbfc1d</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'.