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": "fa046b1b-87cb-426c-b7c2-133e0fe2f79e",
  "messageRouteRepresentation": {
    "messageRouteId": "45767658-cd27-440a-92ee-1f8283897253",
    "tenantId": "6d5684b4-8979-4ca4-bd62-42a246c84473",
    "messageTypeId": "7f7b4b24-fd85-4103-9cdf-a5064a5e9309",
    "userId": "c475c155-7a9b-4ce1-8981-5043f5f82faf",
    "userGroupId": "f5e81996-9477-4217-807f-1d63b2c8080c",
    "deviceId": "e2884c57-ece6-4e9b-befe-01a009fcdb96",
    "deviceGroupId": "b1f72d94-a7c6-443d-bf4a-eaade828322b",
    "applicationId": "214f76b4-9199-461b-8fd3-92a15472ce09",
    "applicationVersionId": "2dcc5cc4-6c5e-4516-a473-568591994fea",
    "messageDestinationId": "25746f49-1baf-4aed-844e-c3561bd0a037",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-04-24T23:47:45.5554095+00:00",
    "updatedDateUtc": "2026-04-24T23:47:45.5554095+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "2b9580f6-6021-43cf-9846-d4c25aaadafd",
    "messageDestinationTypeId": "37c96a3e-521c-465c-9a5e-a112f33e7664",
    "tenantId": "b3bf0e35-253c-4c9f-97e8-fd6c51c40f55",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-04-24T23:47:45.5554095+00:00",
    "updatedDateUtc": "2026-04-24T23:47:45.5554095+00:00"
  },
  "createdDateUtc": "2026-04-24T23:47:45.5554095+00:00",
  "updatedDateUtc": "2026-04-24T23:47:45.5554095+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-04-24T23:47:45.5554095+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-04-24T23:47:45.5554095+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-04-24T23:47:45.5554095+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-24T23:47:45.5554095+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>2b9580f6-6021-43cf-9846-d4c25aaadafd</MessageDestinationId>
    <MessageDestinationTypeId>37c96a3e-521c-465c-9a5e-a112f33e7664</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>b3bf0e35-253c-4c9f-97e8-fd6c51c40f55</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-04-24T23:47:45.5554095+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-04-24T23:47:45.5554095+00:00</UpdatedDateUtc>
    <ApplicationId>214f76b4-9199-461b-8fd3-92a15472ce09</ApplicationId>
    <ApplicationVersionId>2dcc5cc4-6c5e-4516-a473-568591994fea</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>b1f72d94-a7c6-443d-bf4a-eaade828322b</DeviceGroupId>
    <DeviceId>e2884c57-ece6-4e9b-befe-01a009fcdb96</DeviceId>
    <MessageDestinationId>25746f49-1baf-4aed-844e-c3561bd0a037</MessageDestinationId>
    <MessageRouteId>45767658-cd27-440a-92ee-1f8283897253</MessageRouteId>
    <MessageTypeId>7f7b4b24-fd85-4103-9cdf-a5064a5e9309</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>6d5684b4-8979-4ca4-bd62-42a246c84473</TenantId>
    <UserGroupId>f5e81996-9477-4217-807f-1d63b2c8080c</UserGroupId>
    <UserId>c475c155-7a9b-4ce1-8981-5043f5f82faf</UserId>
  </MessageRouteRepresentation>
  <TenantId>fa046b1b-87cb-426c-b7c2-133e0fe2f79e</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'.