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": "3b76b892-08c2-445d-ab2d-3a6ae84f1917",
  "messageRouteRepresentation": {
    "messageRouteId": "f1b5e214-259f-4d13-880e-5830ee439ebd",
    "tenantId": "eeb2d6f9-08f9-43f0-ad03-c2d7ac24c9a4",
    "messageTypeId": "459877b1-a77f-4834-93c2-92a9f082f416",
    "userId": "e2b2dd7a-e86a-4f53-85c2-1f6e3ae52c93",
    "userGroupId": "5873441d-9a8b-412c-acef-201bff735d7d",
    "deviceId": "82dd61d8-d363-4610-a7ab-5d995b0b1ffc",
    "deviceGroupId": "5e3c7bb5-f5d5-4656-b6b3-a4dd43150e06",
    "applicationId": "ade1b8fe-7050-40ee-a565-13fbcb3e8fc6",
    "applicationVersionId": "bbf0f255-9eae-44b8-a3d9-ced3d53e5fe5",
    "messageDestinationId": "6526d769-cfaa-4034-8aca-8916bd498f3f",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-07-10T07:33:29.4687148+00:00",
    "updatedDateUtc": "2026-07-10T07:33:29.4687148+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "023f9103-0d48-452c-a5d4-0200fa7e5b15",
    "messageDestinationTypeId": "844bffde-97a1-4f6b-a577-38d7d2d5dec2",
    "tenantId": "d4340d57-9465-4935-989b-3c0cb4b1dd71",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-07-10T07:33:29.4687148+00:00",
    "updatedDateUtc": "2026-07-10T07:33:29.4687148+00:00"
  },
  "createdDateUtc": "2026-07-10T07:33:29.4687148+00:00",
  "updatedDateUtc": "2026-07-10T07:33:29.4687148+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-07-10T07:33:29.4687148+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-07-10T07:33:29.4687148+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-07-10T07:33:29.4687148+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-07-10T07:33:29.4687148+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>023f9103-0d48-452c-a5d4-0200fa7e5b15</MessageDestinationId>
    <MessageDestinationTypeId>844bffde-97a1-4f6b-a577-38d7d2d5dec2</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>d4340d57-9465-4935-989b-3c0cb4b1dd71</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-07-10T07:33:29.4687148+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-07-10T07:33:29.4687148+00:00</UpdatedDateUtc>
    <ApplicationId>ade1b8fe-7050-40ee-a565-13fbcb3e8fc6</ApplicationId>
    <ApplicationVersionId>bbf0f255-9eae-44b8-a3d9-ced3d53e5fe5</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>5e3c7bb5-f5d5-4656-b6b3-a4dd43150e06</DeviceGroupId>
    <DeviceId>82dd61d8-d363-4610-a7ab-5d995b0b1ffc</DeviceId>
    <MessageDestinationId>6526d769-cfaa-4034-8aca-8916bd498f3f</MessageDestinationId>
    <MessageRouteId>f1b5e214-259f-4d13-880e-5830ee439ebd</MessageRouteId>
    <MessageTypeId>459877b1-a77f-4834-93c2-92a9f082f416</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>eeb2d6f9-08f9-43f0-ad03-c2d7ac24c9a4</TenantId>
    <UserGroupId>5873441d-9a8b-412c-acef-201bff735d7d</UserGroupId>
    <UserId>e2b2dd7a-e86a-4f53-85c2-1f6e3ae52c93</UserId>
  </MessageRouteRepresentation>
  <TenantId>3b76b892-08c2-445d-ab2d-3a6ae84f1917</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'.