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": "1943d768-324b-4063-9a5f-6711d82188c3",
  "messageRouteRepresentation": {
    "messageRouteId": "002828be-ac7a-4226-be75-b52d99e1fad1",
    "tenantId": "d97e1bd7-4827-4589-9812-bc622264b583",
    "messageTypeId": "f4c430d8-5df5-4db2-9b5a-897b4b7f2376",
    "userId": "5878aa10-4b3c-4a09-9037-6a4df6159cab",
    "userGroupId": "1e4d1236-5652-4cf2-9aec-7aecea40abf5",
    "deviceId": "476aa884-4b98-4757-8150-25002cc8c38f",
    "deviceGroupId": "056b8230-72d2-409b-81a7-7ffbc75c290c",
    "applicationId": "0df9d444-ba40-401b-a06a-6b2c016eb8b7",
    "applicationVersionId": "f460e360-3a95-4191-992e-4218cdf7cebc",
    "messageDestinationId": "fba4eb1f-c472-4e0e-8c10-f2745519c9c1",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-07-05T15:45:26.8743691+00:00",
    "updatedDateUtc": "2025-07-05T15:45:26.8743691+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "998f917f-1802-4ed5-8235-fa5c8930e11c",
    "messageDestinationTypeId": "ff2993ee-2265-4962-ac90-bd7d12ec75f4",
    "tenantId": "e72267e8-7e1c-4b92-aa5e-4116104522c4",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-07-05T15:45:26.8743691+00:00",
    "updatedDateUtc": "2025-07-05T15:45:26.8743691+00:00"
  },
  "createdDateUtc": "2025-07-05T15:45:26.8743691+00:00",
  "updatedDateUtc": "2025-07-05T15:45:26.8743691+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-07-05T15:45:26.8743691+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-07-05T15:45:26.8743691+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-07-05T15:45:26.8743691+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:45:26.8743691+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>998f917f-1802-4ed5-8235-fa5c8930e11c</MessageDestinationId>
    <MessageDestinationTypeId>ff2993ee-2265-4962-ac90-bd7d12ec75f4</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>e72267e8-7e1c-4b92-aa5e-4116104522c4</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-07-05T15:45:26.8743691+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-07-05T15:45:26.8743691+00:00</UpdatedDateUtc>
    <ApplicationId>0df9d444-ba40-401b-a06a-6b2c016eb8b7</ApplicationId>
    <ApplicationVersionId>f460e360-3a95-4191-992e-4218cdf7cebc</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>056b8230-72d2-409b-81a7-7ffbc75c290c</DeviceGroupId>
    <DeviceId>476aa884-4b98-4757-8150-25002cc8c38f</DeviceId>
    <MessageDestinationId>fba4eb1f-c472-4e0e-8c10-f2745519c9c1</MessageDestinationId>
    <MessageRouteId>002828be-ac7a-4226-be75-b52d99e1fad1</MessageRouteId>
    <MessageTypeId>f4c430d8-5df5-4db2-9b5a-897b4b7f2376</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>d97e1bd7-4827-4589-9812-bc622264b583</TenantId>
    <UserGroupId>1e4d1236-5652-4cf2-9aec-7aecea40abf5</UserGroupId>
    <UserId>5878aa10-4b3c-4a09-9037-6a4df6159cab</UserId>
  </MessageRouteRepresentation>
  <TenantId>1943d768-324b-4063-9a5f-6711d82188c3</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.