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": "3b6b3508-d00e-4665-946b-565ba6f7e814",
  "messageRouteRepresentation": {
    "messageRouteId": "e4993f7c-08bb-498a-9dca-ca1e8ce30523",
    "tenantId": "40917ff9-56e1-4859-8f39-f8b2d36bd571",
    "messageTypeId": "4a5f82fd-f884-4044-8605-8796c228c523",
    "userId": "23c237d7-2d08-4eed-810d-7a748c71b31f",
    "userGroupId": "a01cc986-4a34-4203-85d2-a6e461d9f604",
    "deviceId": "edcb9587-260d-4a86-89d2-ad4cf978699e",
    "deviceGroupId": "2dc7f6b4-732e-4519-98be-f69a8228716b",
    "applicationId": "a6e21026-d523-4759-b91e-c1e271431b96",
    "applicationVersionId": "2f0a722e-7435-49b7-8f5e-db1ac51fdc39",
    "messageDestinationId": "4efa6d3b-7d5f-460d-9a57-cd90aa29dd74",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-06-08T07:02:23.3464685+00:00",
    "updatedDateUtc": "2026-06-08T07:02:23.3464685+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "32b2febf-2fe3-4de1-af31-ad457827a89d",
    "messageDestinationTypeId": "c4bad620-cd96-4867-b187-89e72be7a4dc",
    "tenantId": "c296cb1f-9028-470a-bfd1-0206b882cc83",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-06-08T07:02:23.3464685+00:00",
    "updatedDateUtc": "2026-06-08T07:02:23.3464685+00:00"
  },
  "createdDateUtc": "2026-06-08T07:02:23.3464685+00:00",
  "updatedDateUtc": "2026-06-08T07:02:23.3464685+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-06-08T07:02:23.3464685+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-06-08T07:02:23.3464685+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-06-08T07:02:23.3464685+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-06-08T07:02:23.3464685+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>32b2febf-2fe3-4de1-af31-ad457827a89d</MessageDestinationId>
    <MessageDestinationTypeId>c4bad620-cd96-4867-b187-89e72be7a4dc</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>c296cb1f-9028-470a-bfd1-0206b882cc83</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-06-08T07:02:23.3464685+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-06-08T07:02:23.3464685+00:00</UpdatedDateUtc>
    <ApplicationId>a6e21026-d523-4759-b91e-c1e271431b96</ApplicationId>
    <ApplicationVersionId>2f0a722e-7435-49b7-8f5e-db1ac51fdc39</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>2dc7f6b4-732e-4519-98be-f69a8228716b</DeviceGroupId>
    <DeviceId>edcb9587-260d-4a86-89d2-ad4cf978699e</DeviceId>
    <MessageDestinationId>4efa6d3b-7d5f-460d-9a57-cd90aa29dd74</MessageDestinationId>
    <MessageRouteId>e4993f7c-08bb-498a-9dca-ca1e8ce30523</MessageRouteId>
    <MessageTypeId>4a5f82fd-f884-4044-8605-8796c228c523</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>40917ff9-56e1-4859-8f39-f8b2d36bd571</TenantId>
    <UserGroupId>a01cc986-4a34-4203-85d2-a6e461d9f604</UserGroupId>
    <UserId>23c237d7-2d08-4eed-810d-7a748c71b31f</UserId>
  </MessageRouteRepresentation>
  <TenantId>3b6b3508-d00e-4665-946b-565ba6f7e814</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'.