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": "de14f9ed-6daa-439e-b595-ea7655bab01e",
  "messageRouteRepresentation": {
    "messageRouteId": "f65e66be-9256-4763-8137-2e53a0ca2e5a",
    "tenantId": "fd6bfd5b-d228-47d0-9331-d26601b9e755",
    "messageTypeId": "2c91b1e0-556d-4e46-abe4-640b7197d7b5",
    "userId": "627e685f-071c-40a7-ba8b-bec6101068b5",
    "userGroupId": "f6f2e62a-7343-4e28-8060-65e078211962",
    "deviceId": "7c09ed78-e7cb-4c3e-8ea9-6b68e49d9698",
    "deviceGroupId": "480446ab-3f96-42e8-b928-adf98dc851c6",
    "applicationId": "0907132f-fb59-4cc1-af98-2583057cb694",
    "applicationVersionId": "276f9cb3-6901-4f24-9edb-d6c31ca47aea",
    "messageDestinationId": "635439c8-9967-4df4-87fe-472bbb7ccb98",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-10-23T00:08:28.2954875+00:00",
    "updatedDateUtc": "2026-10-23T00:08:28.2954875+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "0fdb0a90-b53d-4834-b396-514c394acbf0",
    "messageDestinationTypeId": "3aa14355-758b-435c-8a58-71ef35b47168",
    "tenantId": "59955ba9-a95c-4141-a917-84ac5cf96529",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-10-23T00:08:28.2954875+00:00",
    "updatedDateUtc": "2026-10-23T00:08:28.2954875+00:00"
  },
  "createdDateUtc": "2026-10-23T00:08:28.2954875+00:00",
  "updatedDateUtc": "2026-10-23T00:08:28.2954875+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-10-23T00:08:28.2954875+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-10-23T00:08:28.2954875+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-10-23T00:08:28.2954875+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-10-23T00:08:28.2954875+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>0fdb0a90-b53d-4834-b396-514c394acbf0</MessageDestinationId>
    <MessageDestinationTypeId>3aa14355-758b-435c-8a58-71ef35b47168</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>59955ba9-a95c-4141-a917-84ac5cf96529</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-10-23T00:08:28.2954875+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-10-23T00:08:28.2954875+00:00</UpdatedDateUtc>
    <ApplicationId>0907132f-fb59-4cc1-af98-2583057cb694</ApplicationId>
    <ApplicationVersionId>276f9cb3-6901-4f24-9edb-d6c31ca47aea</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>480446ab-3f96-42e8-b928-adf98dc851c6</DeviceGroupId>
    <DeviceId>7c09ed78-e7cb-4c3e-8ea9-6b68e49d9698</DeviceId>
    <MessageDestinationId>635439c8-9967-4df4-87fe-472bbb7ccb98</MessageDestinationId>
    <MessageRouteId>f65e66be-9256-4763-8137-2e53a0ca2e5a</MessageRouteId>
    <MessageTypeId>2c91b1e0-556d-4e46-abe4-640b7197d7b5</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>fd6bfd5b-d228-47d0-9331-d26601b9e755</TenantId>
    <UserGroupId>f6f2e62a-7343-4e28-8060-65e078211962</UserGroupId>
    <UserId>627e685f-071c-40a7-ba8b-bec6101068b5</UserId>
  </MessageRouteRepresentation>
  <TenantId>de14f9ed-6daa-439e-b595-ea7655bab01e</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'.