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": "00cf6a4f-6fdb-4de1-9731-4d22bffb21cf",
  "messageRouteRepresentation": {
    "messageRouteId": "c0cc3e36-1609-448f-8f39-02f96e959e5c",
    "tenantId": "c92abc2a-98dc-469a-88e9-031dab262bb8",
    "messageTypeId": "b3521260-05b3-44a3-91e4-a293d2cd461c",
    "userId": "539ee29d-91f1-46c6-9da9-371ca9a3bb9f",
    "userGroupId": "a53aa891-d561-4a5b-8b34-4e10ac368af5",
    "deviceId": "660099e3-6a80-4bca-a8d4-bb841347ac5b",
    "deviceGroupId": "70cd8346-d0d6-45c3-a699-39f54b946b63",
    "applicationId": "30a9ccd0-2b03-4be6-80f2-9ec3f9de1cdd",
    "applicationVersionId": "3ca32e7b-430f-4cb1-9f63-4f9ae3021900",
    "messageDestinationId": "5815ca17-cb46-4522-ac7f-a6b447347b2c",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2025-12-15T19:43:19.4595931+00:00",
    "updatedDateUtc": "2025-12-15T19:43:19.4595931+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "437488a6-24d8-4968-b5b0-870f2d026cbf",
    "messageDestinationTypeId": "86b91de3-2c7e-4e04-80b2-d9b1cf65917d",
    "tenantId": "e2a7bbb3-649c-4b45-8554-3a18c03b51fc",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2025-12-15T19:43:19.4595931+00:00",
    "updatedDateUtc": "2025-12-15T19:43:19.4595931+00:00"
  },
  "createdDateUtc": "2025-12-15T19:43:19.4595931+00:00",
  "updatedDateUtc": "2025-12-15T19:43:19.4595931+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-12-15T19:43:19.4595931+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-12-15T19:43:19.4595931+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2025-12-15T19:43:19.4595931+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-15T19:43:19.4595931+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>437488a6-24d8-4968-b5b0-870f2d026cbf</MessageDestinationId>
    <MessageDestinationTypeId>86b91de3-2c7e-4e04-80b2-d9b1cf65917d</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>e2a7bbb3-649c-4b45-8554-3a18c03b51fc</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2025-12-15T19:43:19.4595931+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2025-12-15T19:43:19.4595931+00:00</UpdatedDateUtc>
    <ApplicationId>30a9ccd0-2b03-4be6-80f2-9ec3f9de1cdd</ApplicationId>
    <ApplicationVersionId>3ca32e7b-430f-4cb1-9f63-4f9ae3021900</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>70cd8346-d0d6-45c3-a699-39f54b946b63</DeviceGroupId>
    <DeviceId>660099e3-6a80-4bca-a8d4-bb841347ac5b</DeviceId>
    <MessageDestinationId>5815ca17-cb46-4522-ac7f-a6b447347b2c</MessageDestinationId>
    <MessageRouteId>c0cc3e36-1609-448f-8f39-02f96e959e5c</MessageRouteId>
    <MessageTypeId>b3521260-05b3-44a3-91e4-a293d2cd461c</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>c92abc2a-98dc-469a-88e9-031dab262bb8</TenantId>
    <UserGroupId>a53aa891-d561-4a5b-8b34-4e10ac368af5</UserGroupId>
    <UserId>539ee29d-91f1-46c6-9da9-371ca9a3bb9f</UserId>
  </MessageRouteRepresentation>
  <TenantId>00cf6a4f-6fdb-4de1-9731-4d22bffb21cf</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.