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": "ed104618-8d6d-46b0-8591-1851fcc9aaf5",
  "messageRouteRepresentation": {
    "messageRouteId": "5cc8fce0-21b1-4d31-bbd7-ced87f4590b9",
    "tenantId": "9f143fb0-c1e8-400f-9803-cd0063f61506",
    "messageTypeId": "7221da43-cfd3-4a85-a26d-3ac150dd5b1e",
    "userId": "c85f3b50-ee5c-4c11-bf6f-42cbd55cf69e",
    "userGroupId": "5b9b82b6-0ca7-4ba4-8ba8-8140f175ffb8",
    "deviceId": "978d932a-97be-4044-b524-f6aa99465cc7",
    "deviceGroupId": "4608629e-afb8-4774-9298-f53d4c8bbba2",
    "applicationId": "ac4486c4-ad1b-4736-983a-7a6bb1f5bdff",
    "applicationVersionId": "8be6bb07-163d-4cfc-98e0-ac9926969d76",
    "messageDestinationId": "2deb6df4-102f-474e-9482-9a44c7ecbc63",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-08-27T04:31:18.5772581+00:00",
    "updatedDateUtc": "2026-08-27T04:31:18.5772581+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "2f8fa2bb-4a88-4d51-942b-8d9d614125ec",
    "messageDestinationTypeId": "0799ec1c-20b1-44e2-ad24-09f70f80534e",
    "tenantId": "e66fd4a6-e8b9-4e70-9e95-b5adb3afe204",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-08-27T04:31:18.5772581+00:00",
    "updatedDateUtc": "2026-08-27T04:31:18.5772581+00:00"
  },
  "createdDateUtc": "2026-08-27T04:31:18.5772581+00:00",
  "updatedDateUtc": "2026-08-27T04:31:18.5772581+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-27T04:31:18.5772581+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-08-27T04:31:18.5772581+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-08-27T04:31:18.5772581+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-08-27T04:31:18.5772581+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>2f8fa2bb-4a88-4d51-942b-8d9d614125ec</MessageDestinationId>
    <MessageDestinationTypeId>0799ec1c-20b1-44e2-ad24-09f70f80534e</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>e66fd4a6-e8b9-4e70-9e95-b5adb3afe204</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-08-27T04:31:18.5772581+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-08-27T04:31:18.5772581+00:00</UpdatedDateUtc>
    <ApplicationId>ac4486c4-ad1b-4736-983a-7a6bb1f5bdff</ApplicationId>
    <ApplicationVersionId>8be6bb07-163d-4cfc-98e0-ac9926969d76</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>4608629e-afb8-4774-9298-f53d4c8bbba2</DeviceGroupId>
    <DeviceId>978d932a-97be-4044-b524-f6aa99465cc7</DeviceId>
    <MessageDestinationId>2deb6df4-102f-474e-9482-9a44c7ecbc63</MessageDestinationId>
    <MessageRouteId>5cc8fce0-21b1-4d31-bbd7-ced87f4590b9</MessageRouteId>
    <MessageTypeId>7221da43-cfd3-4a85-a26d-3ac150dd5b1e</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>9f143fb0-c1e8-400f-9803-cd0063f61506</TenantId>
    <UserGroupId>5b9b82b6-0ca7-4ba4-8ba8-8140f175ffb8</UserGroupId>
    <UserId>c85f3b50-ee5c-4c11-bf6f-42cbd55cf69e</UserId>
  </MessageRouteRepresentation>
  <TenantId>ed104618-8d6d-46b0-8591-1851fcc9aaf5</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'.