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": "67c64203-0aaa-414d-9efe-8855287b41f1",
  "messageRouteRepresentation": {
    "messageRouteId": "22cec4e6-1dd0-4c95-baef-b9af43aecf44",
    "tenantId": "90601774-2341-41f7-9cfc-f8877f5534ac",
    "messageTypeId": "44ff013c-ba6d-4d89-a345-8277aa2fbec0",
    "userId": "356e714f-e6ed-4a56-a690-283fe82a841a",
    "userGroupId": "90208814-ab9e-4933-8c37-9e9d9dda4539",
    "deviceId": "e083cbce-48f8-406d-89cf-0cf7fa4dd3fd",
    "deviceGroupId": "a03e520e-7c1c-4461-9bae-68e2e477026b",
    "applicationId": "f1063741-f491-438e-9e55-66b3426061ab",
    "applicationVersionId": "0e758279-0c49-47ad-83ac-428ec7b9ee29",
    "messageDestinationId": "b7968989-e7ec-4369-90b7-b822bf481a60",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-02-01T08:28:23.0101425+00:00",
    "updatedDateUtc": "2026-02-01T08:28:23.0101425+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "f4c2b240-92d5-4a74-b54b-6e24f623e5e7",
    "messageDestinationTypeId": "dad2c43b-65b6-4c00-a59a-c319530ce903",
    "tenantId": "e28d35a9-f7a3-41ff-a30b-3f4f73bc4fe7",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-02-01T08:28:23.0101425+00:00",
    "updatedDateUtc": "2026-02-01T08:28:23.0101425+00:00"
  },
  "createdDateUtc": "2026-02-01T08:28:23.0101425+00:00",
  "updatedDateUtc": "2026-02-01T08:28:23.0101425+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-02-01T08:28:23.0101425+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-02-01T08:28:23.0101425+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-02-01T08:28:23.0101425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-01T08:28:23.0101425+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>f4c2b240-92d5-4a74-b54b-6e24f623e5e7</MessageDestinationId>
    <MessageDestinationTypeId>dad2c43b-65b6-4c00-a59a-c319530ce903</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>e28d35a9-f7a3-41ff-a30b-3f4f73bc4fe7</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-02-01T08:28:23.0101425+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-02-01T08:28:23.0101425+00:00</UpdatedDateUtc>
    <ApplicationId>f1063741-f491-438e-9e55-66b3426061ab</ApplicationId>
    <ApplicationVersionId>0e758279-0c49-47ad-83ac-428ec7b9ee29</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>a03e520e-7c1c-4461-9bae-68e2e477026b</DeviceGroupId>
    <DeviceId>e083cbce-48f8-406d-89cf-0cf7fa4dd3fd</DeviceId>
    <MessageDestinationId>b7968989-e7ec-4369-90b7-b822bf481a60</MessageDestinationId>
    <MessageRouteId>22cec4e6-1dd0-4c95-baef-b9af43aecf44</MessageRouteId>
    <MessageTypeId>44ff013c-ba6d-4d89-a345-8277aa2fbec0</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>90601774-2341-41f7-9cfc-f8877f5534ac</TenantId>
    <UserGroupId>90208814-ab9e-4933-8c37-9e9d9dda4539</UserGroupId>
    <UserId>356e714f-e6ed-4a56-a690-283fe82a841a</UserId>
  </MessageRouteRepresentation>
  <TenantId>67c64203-0aaa-414d-9efe-8855287b41f1</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'.