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": "dde7732b-adba-42e3-8e90-2022f1dea326",
  "messageRouteRepresentation": {
    "messageRouteId": "4c5948ee-8b3f-4e39-9d56-a28989e2de92",
    "tenantId": "84be1df3-2e3e-443b-a189-b64d5943c707",
    "messageTypeId": "0e476ebe-198f-4858-82dd-d8fd077bed77",
    "userId": "0917507e-c1e1-4e0e-bcc9-51a9516fbfaa",
    "userGroupId": "b0dd620f-8140-4439-b937-0481eb47070e",
    "deviceId": "3c6f0046-a9d0-4be9-b277-f0a678a84726",
    "deviceGroupId": "394f661a-fa62-49a9-b0a1-be3fcbab1986",
    "applicationId": "033b7077-e2ee-4ed8-a250-d9156e80c238",
    "applicationVersionId": "368d6a49-e961-4b5f-8ca8-fa2520fa4924",
    "messageDestinationId": "7bdabfe4-ba29-4e89-9057-59e1e3a854e9",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-02-04T01:50:52.7237809+00:00",
    "updatedDateUtc": "2026-02-04T01:50:52.7237809+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "e7ab635a-8d83-4449-b51e-bf6a35677a5d",
    "messageDestinationTypeId": "330e4f29-c7e3-4b47-97c4-c2ce400ce6a1",
    "tenantId": "8f5debc2-7593-4f72-af3f-d72144b0b93d",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-02-04T01:50:52.7237809+00:00",
    "updatedDateUtc": "2026-02-04T01:50:52.7237809+00:00"
  },
  "createdDateUtc": "2026-02-04T01:50:52.7237809+00:00",
  "updatedDateUtc": "2026-02-04T01:50:52.7237809+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-04T01:50:52.7237809+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-04T01:50:52.7237809+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-02-04T01:50:52.7237809+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-04T01:50:52.7237809+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>e7ab635a-8d83-4449-b51e-bf6a35677a5d</MessageDestinationId>
    <MessageDestinationTypeId>330e4f29-c7e3-4b47-97c4-c2ce400ce6a1</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>8f5debc2-7593-4f72-af3f-d72144b0b93d</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-02-04T01:50:52.7237809+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-04T01:50:52.7237809+00:00</UpdatedDateUtc>
    <ApplicationId>033b7077-e2ee-4ed8-a250-d9156e80c238</ApplicationId>
    <ApplicationVersionId>368d6a49-e961-4b5f-8ca8-fa2520fa4924</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>394f661a-fa62-49a9-b0a1-be3fcbab1986</DeviceGroupId>
    <DeviceId>3c6f0046-a9d0-4be9-b277-f0a678a84726</DeviceId>
    <MessageDestinationId>7bdabfe4-ba29-4e89-9057-59e1e3a854e9</MessageDestinationId>
    <MessageRouteId>4c5948ee-8b3f-4e39-9d56-a28989e2de92</MessageRouteId>
    <MessageTypeId>0e476ebe-198f-4858-82dd-d8fd077bed77</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>84be1df3-2e3e-443b-a189-b64d5943c707</TenantId>
    <UserGroupId>b0dd620f-8140-4439-b937-0481eb47070e</UserGroupId>
    <UserId>0917507e-c1e1-4e0e-bcc9-51a9516fbfaa</UserId>
  </MessageRouteRepresentation>
  <TenantId>dde7732b-adba-42e3-8e90-2022f1dea326</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.