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": "a9868edb-dcff-4976-aafa-835043bbe5ad",
  "messageRouteRepresentation": {
    "messageRouteId": "bf351d0e-1aad-4cbe-bf32-c245cadcff01",
    "tenantId": "a96f853f-c836-4cce-9bfa-61bbb772e92e",
    "messageTypeId": "c236b465-1b1c-449c-b0e0-4c78eea91933",
    "userId": "2ce0e7a3-c18c-4765-8e86-abaad44b09b3",
    "userGroupId": "0a462777-a978-4399-b00b-9f211c075a58",
    "deviceId": "bc29f39b-6dbf-4030-b175-716053b3e40b",
    "deviceGroupId": "467b225a-2525-4736-8733-5dcdc03ba1db",
    "applicationId": "cfcaa992-916d-4698-981f-13a58505225a",
    "applicationVersionId": "bacf6d17-13d7-4c66-84e7-34034807794e",
    "messageDestinationId": "521dd2cf-0fbd-4383-9331-d515efcf811a",
    "name": "sample string 4",
    "description": "sample string 5",
    "createdDateUtc": "2026-03-22T21:55:17.4226646+00:00",
    "updatedDateUtc": "2026-03-22T21:55:17.4226646+00:00"
  },
  "messageDestinationRepresentation": {
    "messageDestinationId": "ff30f20b-e406-41a8-80f6-5acd9f03e187",
    "messageDestinationTypeId": "5e2bc25b-28a4-4805-8ba1-02f19cbefae6",
    "tenantId": "d6b8a0b9-33a5-40d4-a055-4027a82cb4d8",
    "name": "sample string 4",
    "description": "sample string 5",
    "address": "sample string 6",
    "createdDateUtc": "2026-03-22T21:55:17.4226646+00:00",
    "updatedDateUtc": "2026-03-22T21:55:17.4226646+00:00"
  },
  "createdDateUtc": "2026-03-22T21:55:17.4226646+00:00",
  "updatedDateUtc": "2026-03-22T21:55:17.4226646+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-03-22T21:55:17.4226646+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2026-03-22T21:55:17.4226646+00:00</UpdatedDateUtc>
  <MessageDestinationRepresentation>
    <CreatedDateUtc>2026-03-22T21:55:17.4226646+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-22T21:55:17.4226646+00:00</UpdatedDateUtc>
    <Address>sample string 6</Address>
    <Description>sample string 5</Description>
    <MessageDestinationId>ff30f20b-e406-41a8-80f6-5acd9f03e187</MessageDestinationId>
    <MessageDestinationTypeId>5e2bc25b-28a4-4805-8ba1-02f19cbefae6</MessageDestinationTypeId>
    <Name>sample string 4</Name>
    <TenantId>d6b8a0b9-33a5-40d4-a055-4027a82cb4d8</TenantId>
  </MessageDestinationRepresentation>
  <MessageRouteRepresentation>
    <CreatedDateUtc>2026-03-22T21:55:17.4226646+00:00</CreatedDateUtc>
    <UpdatedDateUtc>2026-03-22T21:55:17.4226646+00:00</UpdatedDateUtc>
    <ApplicationId>cfcaa992-916d-4698-981f-13a58505225a</ApplicationId>
    <ApplicationVersionId>bacf6d17-13d7-4c66-84e7-34034807794e</ApplicationVersionId>
    <Description>sample string 5</Description>
    <DeviceGroupId>467b225a-2525-4736-8733-5dcdc03ba1db</DeviceGroupId>
    <DeviceId>bc29f39b-6dbf-4030-b175-716053b3e40b</DeviceId>
    <MessageDestinationId>521dd2cf-0fbd-4383-9331-d515efcf811a</MessageDestinationId>
    <MessageRouteId>bf351d0e-1aad-4cbe-bf32-c245cadcff01</MessageRouteId>
    <MessageTypeId>c236b465-1b1c-449c-b0e0-4c78eea91933</MessageTypeId>
    <Name>sample string 4</Name>
    <TenantId>a96f853f-c836-4cce-9bfa-61bbb772e92e</TenantId>
    <UserGroupId>0a462777-a978-4399-b00b-9f211c075a58</UserGroupId>
    <UserId>2ce0e7a3-c18c-4765-8e86-abaad44b09b3</UserId>
  </MessageRouteRepresentation>
  <TenantId>a9868edb-dcff-4976-aafa-835043bbe5ad</TenantId>
</MessageRouteDestinationRepresentation>

application/x-www-form-urlencoded

Sample:

Sample not available.