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": "5f91067d-df14-41e4-b432-454c453376da",
  "messageRouteRepresentation": {
    "messageRouteId": "58199121-374b-4e7e-8d7a-0fb0964022b8",
    "tenantId": "56a46f66-1237-44f2-966e-9214d7ce0e0b",
    "messageTypeId": "001b6c68-59a1-4e72-a14e-4626ce74ec02",
    "userId": "527982fc-460f-48ea-bda5-71d5fe456159",
    "userGroupId": "601e3fe8-20b0-48e9-ad28-f14c9d2e6d1b",
    "deviceId": "6e40517e-b089-48c1-ad0f-b16db57ee5af",
    "deviceGroupId": "aa20b03d-1ea4-4cfd-9f4f-9c7b3967d074",
    "applicationId": "ed6d7fc7-0986-4c7a-8ae9-7a58d6c7f0c3",
    "applicationVersionId": "037db2d8-3809-4011-8e61-c1fec57039a0",
    "messageDestinationId": "a5c6f612-1cba-4947-9b1b-c33a9bcf1812",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-10-07T03:43:43.7639762+00:00",
    "updatedDateUtc": "2025-10-07T03:43:43.7639762+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "017bd1c7-c2c3-4bc0-a4c4-872a4e58bfad",
    "messageDestinationTypeId": "6d461f42-a5fe-464b-ae61-9da6e6efcbe3",
    "tenantId": "049d6b5d-4cb4-4b27-80d1-62c6d5b319a3",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-10-07T03:43:43.7639762+00:00",
    "updatedDateUtc": "2025-10-07T03:43:43.7639762+00:00"
  },
  "createdDateUtc": "2025-10-07T03:43:43.7639762+00:00",
  "updatedDateUtc": "2025-10-07T03:43:43.7639762+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>2025-10-07T03:43:43.7639762+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-10-07T03:43:43.7639762+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-10-07T03:43:43.7639762+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-10-07T03:43:43.7639762+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>017bd1c7-c2c3-4bc0-a4c4-872a4e58bfad</MessageDestinationId>
    <MessageDestinationTypeId>6d461f42-a5fe-464b-ae61-9da6e6efcbe3</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>049d6b5d-4cb4-4b27-80d1-62c6d5b319a3</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-10-07T03:43:43.7639762+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-10-07T03:43:43.7639762+00:00</UpdatedDateUtc>
    <ApplicationId>ed6d7fc7-0986-4c7a-8ae9-7a58d6c7f0c3</ApplicationId>
    <ApplicationVersionId>037db2d8-3809-4011-8e61-c1fec57039a0</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>aa20b03d-1ea4-4cfd-9f4f-9c7b3967d074</DeviceGroupId>
    <DeviceId>6e40517e-b089-48c1-ad0f-b16db57ee5af</DeviceId>
    <MessageDestinationId>a5c6f612-1cba-4947-9b1b-c33a9bcf1812</MessageDestinationId>
    <MessageRouteId>58199121-374b-4e7e-8d7a-0fb0964022b8</MessageRouteId>
    <MessageTypeId>001b6c68-59a1-4e72-a14e-4626ce74ec02</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>56a46f66-1237-44f2-966e-9214d7ce0e0b</TenantId>
    <UserGroupId>601e3fe8-20b0-48e9-ad28-f14c9d2e6d1b</UserGroupId>
    <UserId>527982fc-460f-48ea-bda5-71d5fe456159</UserId>
  </MessageRouteRepresentation>
  <TenantId>5f91067d-df14-41e4-b432-454c453376da</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.