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": "fc9f4dd1-1ecb-4402-8deb-e29f51420f02",
  "messageRouteRepresentation": {
    "messageRouteId": "f12eb1e8-7cb5-4558-9718-9ad8f7a6abe9",
    "tenantId": "59ef4d63-d500-4b7b-ad02-b6400e879025",
    "messageTypeId": "e23aa9e3-ebd4-44cb-be64-cdd64877290b",
    "userId": "c420d4f2-e9d8-4e52-b2b1-8481b30f45df",
    "userGroupId": "5d724db0-6133-4158-ba79-7e4ee9de2273",
    "deviceId": "97634fbe-883c-4772-b2c7-f0b879a89da4",
    "deviceGroupId": "a1a8dbbc-f3e2-4898-a29e-d6a1af2cac1c",
    "applicationId": "de487cc2-b21f-4d06-a56b-796f5cda2920",
    "applicationVersionId": "6cca6d25-9d2e-48ca-a5f9-a6ae73b36dd8",
    "messageDestinationId": "15ccc9f6-76ed-4e29-b1c5-f6f1b14baf43",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-09-13T07:27:11.4694353+00:00",
    "updatedDateUtc": "2025-09-13T07:27:11.4694353+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "691d9f2d-ff44-44ac-93f9-14d8ce8e3e81",
    "messageDestinationTypeId": "10546686-da96-415d-8700-6e983f4a1aa0",
    "tenantId": "1c9a7cb3-fbc6-4c14-b20c-8aa8d553157f",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-09-13T07:27:11.4694353+00:00",
    "updatedDateUtc": "2025-09-13T07:27:11.4694353+00:00"
  },
  "createdDateUtc": "2025-09-13T07:27:11.4694353+00:00",
  "updatedDateUtc": "2025-09-13T07:27:11.4694353+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-09-13T07:27:11.4694353+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-09-13T07:27:11.4694353+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-09-13T07:27:11.4694353+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-09-13T07:27:11.4694353+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>691d9f2d-ff44-44ac-93f9-14d8ce8e3e81</MessageDestinationId>
    <MessageDestinationTypeId>10546686-da96-415d-8700-6e983f4a1aa0</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>1c9a7cb3-fbc6-4c14-b20c-8aa8d553157f</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-09-13T07:27:11.4694353+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-09-13T07:27:11.4694353+00:00</UpdatedDateUtc>
    <ApplicationId>de487cc2-b21f-4d06-a56b-796f5cda2920</ApplicationId>
    <ApplicationVersionId>6cca6d25-9d2e-48ca-a5f9-a6ae73b36dd8</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>a1a8dbbc-f3e2-4898-a29e-d6a1af2cac1c</DeviceGroupId>
    <DeviceId>97634fbe-883c-4772-b2c7-f0b879a89da4</DeviceId>
    <MessageDestinationId>15ccc9f6-76ed-4e29-b1c5-f6f1b14baf43</MessageDestinationId>
    <MessageRouteId>f12eb1e8-7cb5-4558-9718-9ad8f7a6abe9</MessageRouteId>
    <MessageTypeId>e23aa9e3-ebd4-44cb-be64-cdd64877290b</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>59ef4d63-d500-4b7b-ad02-b6400e879025</TenantId>
    <UserGroupId>5d724db0-6133-4158-ba79-7e4ee9de2273</UserGroupId>
    <UserId>c420d4f2-e9d8-4e52-b2b1-8481b30f45df</UserId>
  </MessageRouteRepresentation>
  <TenantId>fc9f4dd1-1ecb-4402-8deb-e29f51420f02</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.