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": "14e17c10-cce3-49fd-b161-cc41be8fe65a",
  "messageRouteRepresentation": {
    "messageRouteId": "29f04b2f-a404-4605-a0b3-a8caf13002f6",
    "tenantId": "480e6836-54b4-4d3e-ae2a-e5b2531d3c2f",
    "messageTypeId": "c20b42df-e31f-46fb-abf0-748ead75407a",
    "userId": "dccc5cde-d275-49c1-ad17-359516064d73",
    "userGroupId": "2ef3ab6d-5177-4462-98a5-8be3392725c0",
    "deviceId": "a249e7c9-794a-4dbf-992c-e435c031e451",
    "deviceGroupId": "71b8e084-6093-4c8f-81e0-e121e8f4cbf7",
    "applicationId": "64e65c24-c1fa-4809-8302-a486f218ba5e",
    "applicationVersionId": "e026591c-ef1d-4c50-b3f9-8420beefe676",
    "messageDestinationId": "bdda0f57-b6c8-47f4-a09f-c6a4d993f725",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-08-02T06:44:56.6172815+00:00",
    "updatedDateUtc": "2026-08-02T06:44:56.6172815+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "265e92be-746c-42ea-adcc-577107c60ff0",
    "messageDestinationTypeId": "37714d41-1d88-4efb-89e5-4a9bdea9b4e4",
    "tenantId": "78f9d0d3-2797-4023-bea1-2af8ac25cd6c",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-08-02T06:44:56.6172815+00:00",
    "updatedDateUtc": "2026-08-02T06:44:56.6172815+00:00"
  },
  "createdDateUtc": "2026-08-02T06:44:56.6172815+00:00",
  "updatedDateUtc": "2026-08-02T06:44:56.6172815+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-08-02T06:44:56.6172815+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-02T06:44:56.6172815+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-08-02T06:44:56.6172815+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-08-02T06:44:56.6172815+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>265e92be-746c-42ea-adcc-577107c60ff0</MessageDestinationId>
    <MessageDestinationTypeId>37714d41-1d88-4efb-89e5-4a9bdea9b4e4</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>78f9d0d3-2797-4023-bea1-2af8ac25cd6c</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-08-02T06:44:56.6172815+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-08-02T06:44:56.6172815+00:00</UpdatedDateUtc>
    <ApplicationId>64e65c24-c1fa-4809-8302-a486f218ba5e</ApplicationId>
    <ApplicationVersionId>e026591c-ef1d-4c50-b3f9-8420beefe676</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>71b8e084-6093-4c8f-81e0-e121e8f4cbf7</DeviceGroupId>
    <DeviceId>a249e7c9-794a-4dbf-992c-e435c031e451</DeviceId>
    <MessageDestinationId>bdda0f57-b6c8-47f4-a09f-c6a4d993f725</MessageDestinationId>
    <MessageRouteId>29f04b2f-a404-4605-a0b3-a8caf13002f6</MessageRouteId>
    <MessageTypeId>c20b42df-e31f-46fb-abf0-748ead75407a</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>480e6836-54b4-4d3e-ae2a-e5b2531d3c2f</TenantId>
    <UserGroupId>2ef3ab6d-5177-4462-98a5-8be3392725c0</UserGroupId>
    <UserId>dccc5cde-d275-49c1-ad17-359516064d73</UserId>
  </MessageRouteRepresentation>
  <TenantId>14e17c10-cce3-49fd-b161-cc41be8fe65a</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'.