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": "11f08a6f-c5d7-4f57-b62b-8e4cac127679",
  "messageRouteRepresentation": {
    "messageRouteId": "913a22a2-18db-45ef-97f6-bedc43b6127c",
    "tenantId": "0990855c-c228-480c-93b2-d59154bf6ee6",
    "messageTypeId": "7b94d8d4-cdf0-4153-93ab-390b410e500e",
    "userId": "a7f03c0b-4473-4f1f-b9bb-4d196b0fd289",
    "userGroupId": "2988d8d6-c37d-4d84-9b81-e2251aa26b68",
    "deviceId": "1d93ebed-6c31-4cbc-95ea-13874fa32fe7",
    "deviceGroupId": "07a2edf5-87bf-4446-aa2d-1bdce4962c32",
    "applicationId": "11edb495-8db0-4eb6-855d-4a99b2a0811a",
    "applicationVersionId": "93af71d4-94af-4ef6-8896-ef751d8a8d27",
    "messageDestinationId": "44c2ef46-9496-41eb-9098-345736619fc4",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-12-14T16:02:40.2314851+00:00",
    "updatedDateUtc": "2025-12-14T16:02:40.2314851+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "43e527b4-b349-4b58-98cd-ed1b3d4ddb68",
    "messageDestinationTypeId": "f96fcfe4-27cb-46e0-af43-ec9e3f539ddd",
    "tenantId": "e6506386-ad5d-42df-97dd-2efd06b0ed72",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-12-14T16:02:40.2314851+00:00",
    "updatedDateUtc": "2025-12-14T16:02:40.2314851+00:00"
  },
  "createdDateUtc": "2025-12-14T16:02:40.2314851+00:00",
  "updatedDateUtc": "2025-12-14T16:02:40.2314851+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-12-14T16:02:40.2314851+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-14T16:02:40.2314851+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-12-14T16:02:40.2314851+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-14T16:02:40.2314851+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>43e527b4-b349-4b58-98cd-ed1b3d4ddb68</MessageDestinationId>
    <MessageDestinationTypeId>f96fcfe4-27cb-46e0-af43-ec9e3f539ddd</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>e6506386-ad5d-42df-97dd-2efd06b0ed72</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-12-14T16:02:40.2314851+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-14T16:02:40.2314851+00:00</UpdatedDateUtc>
    <ApplicationId>11edb495-8db0-4eb6-855d-4a99b2a0811a</ApplicationId>
    <ApplicationVersionId>93af71d4-94af-4ef6-8896-ef751d8a8d27</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>07a2edf5-87bf-4446-aa2d-1bdce4962c32</DeviceGroupId>
    <DeviceId>1d93ebed-6c31-4cbc-95ea-13874fa32fe7</DeviceId>
    <MessageDestinationId>44c2ef46-9496-41eb-9098-345736619fc4</MessageDestinationId>
    <MessageRouteId>913a22a2-18db-45ef-97f6-bedc43b6127c</MessageRouteId>
    <MessageTypeId>7b94d8d4-cdf0-4153-93ab-390b410e500e</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>0990855c-c228-480c-93b2-d59154bf6ee6</TenantId>
    <UserGroupId>2988d8d6-c37d-4d84-9b81-e2251aa26b68</UserGroupId>
    <UserId>a7f03c0b-4473-4f1f-b9bb-4d196b0fd289</UserId>
  </MessageRouteRepresentation>
  <TenantId>11f08a6f-c5d7-4f57-b62b-8e4cac127679</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'.