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

NameDescriptionAdditional 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": "0d920ce4-8578-4d94-b0ba-e6df8543136a",
  "messageRouteRepresentation": {
    "messageRouteId": "ec779d33-5350-451c-bbb5-a541e4def71b",
    "tenantId": "e08d51a9-f676-4b4b-8521-7f1b623de23e",
    "messageTypeId": "dc4d36cf-23ca-4c18-b582-1b98772720ea",
    "userId": "2e498da1-8bec-4d06-99a6-58b388c6ba25",
    "userGroupId": "56768d01-800d-4e90-8361-99f0166a37d7",
    "deviceId": "788dbdad-a80d-4c21-8db6-54cdde0f58a3",
    "deviceGroupId": "865e2aec-e6c7-43b3-b820-9cc9e0a45a58",
    "applicationId": "3b8d8054-ac9e-40a7-a92a-85102069ee42",
    "applicationVersionId": "26683d7a-d29d-479c-aff3-71d2add9f3a2",
    "messageDestinationId": "291325f4-06d6-4b4c-85ee-d76f9147fef1",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-11-05T07:04:23.1688378+00:00",
    "updatedDateUtc": "2026-11-05T07:04:23.1688378+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "fe3126e3-5724-4eca-89bf-72e1000b43d9",
    "messageDestinationTypeId": "cd38d5c2-8b7b-41a5-8cc0-9bb6d1a08e92",
    "tenantId": "bead3be6-0e2d-451d-b877-52c67841c4ab",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-11-05T07:04:23.1688378+00:00",
    "updatedDateUtc": "2026-11-05T07:04:23.1688378+00:00"
  },
  "createdDateUtc": "2026-11-05T07:04:23.1688378+00:00",
  "updatedDateUtc": "2026-11-05T07:04:23.1688378+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-11-05T07:04:23.1688378+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-11-05T07:04:23.1688378+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-11-05T07:04:23.1688378+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-11-05T07:04:23.1688378+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>fe3126e3-5724-4eca-89bf-72e1000b43d9</MessageDestinationId>
    <MessageDestinationTypeId>cd38d5c2-8b7b-41a5-8cc0-9bb6d1a08e92</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>bead3be6-0e2d-451d-b877-52c67841c4ab</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-11-05T07:04:23.1688378+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-11-05T07:04:23.1688378+00:00</UpdatedDateUtc>
    <ApplicationId>3b8d8054-ac9e-40a7-a92a-85102069ee42</ApplicationId>
    <ApplicationVersionId>26683d7a-d29d-479c-aff3-71d2add9f3a2</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>865e2aec-e6c7-43b3-b820-9cc9e0a45a58</DeviceGroupId>
    <DeviceId>788dbdad-a80d-4c21-8db6-54cdde0f58a3</DeviceId>
    <MessageDestinationId>291325f4-06d6-4b4c-85ee-d76f9147fef1</MessageDestinationId>
    <MessageRouteId>ec779d33-5350-451c-bbb5-a541e4def71b</MessageRouteId>
    <MessageTypeId>dc4d36cf-23ca-4c18-b582-1b98772720ea</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>e08d51a9-f676-4b4b-8521-7f1b623de23e</TenantId>
    <UserGroupId>56768d01-800d-4e90-8361-99f0166a37d7</UserGroupId>
    <UserId>2e498da1-8bec-4d06-99a6-58b388c6ba25</UserId>
  </MessageRouteRepresentation>
  <TenantId>0d920ce4-8578-4d94-b0ba-e6df8543136a</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'.