Creates a message route with a destination. A new destination will be created if a messageDestinationId is not passed in
| 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. |
{
"tenantId": "b07dceb6-13a0-4470-933c-1245b00c2c9c",
"messageRouteRepresentation": {
"messageRouteId": "52a83941-18dd-4757-ade2-6544040a1772",
"tenantId": "2dc7db37-1987-4fc6-824c-b75c405b251d",
"messageTypeId": "122296d5-cb67-493a-adea-2236d6d26a77",
"userId": "a731240c-c880-489f-a7c1-f162b104295b",
"userGroupId": "9885112a-463e-4441-9342-dd4bdf8c4034",
"deviceId": "4a06892c-c5dc-4e73-9b27-076f00176b37",
"deviceGroupId": "b8042072-cc10-4b58-b2b3-47cd83954c7b",
"applicationId": "dc84e851-d5eb-4677-afde-709e6517ceed",
"applicationVersionId": "96626490-7496-4cae-8afd-6bebe9c5daa1",
"messageDestinationId": "efec902d-c077-4a15-b907-5c3689d7daeb",
"name": "sample string 4",
"description": "sample string 5",
"createdDateUtc": "2025-07-17T09:10:54.6034698+00:00",
"updatedDateUtc": "2025-07-17T09:10:54.6034698+00:00"
},
"messageDestinationRepresentation": {
"messageDestinationId": "4db507eb-c975-470f-b5c4-e684f4ff4f61",
"messageDestinationTypeId": "eabcc644-e227-4794-8074-ae8d12f0806f",
"tenantId": "0d55c830-e3a6-407a-ae80-5c31d33fdacc",
"name": "sample string 4",
"description": "sample string 5",
"address": "sample string 6",
"createdDateUtc": "2025-07-17T09:10:54.6034698+00:00",
"updatedDateUtc": "2025-07-17T09:10:54.6034698+00:00"
},
"createdDateUtc": "2025-07-17T09:10:54.6034698+00:00",
"updatedDateUtc": "2025-07-17T09:10:54.6034698+00:00"
}
<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-17T09:10:54.6034698+00:00</CreatedDateUtc>
<UpdatedDateUtc>2025-07-17T09:10:54.6034698+00:00</UpdatedDateUtc>
<MessageDestinationRepresentation>
<CreatedDateUtc>2025-07-17T09:10:54.6034698+00:00</CreatedDateUtc>
<UpdatedDateUtc>2025-07-17T09:10:54.6034698+00:00</UpdatedDateUtc>
<Address>sample string 6</Address>
<Description>sample string 5</Description>
<MessageDestinationId>4db507eb-c975-470f-b5c4-e684f4ff4f61</MessageDestinationId>
<MessageDestinationTypeId>eabcc644-e227-4794-8074-ae8d12f0806f</MessageDestinationTypeId>
<Name>sample string 4</Name>
<TenantId>0d55c830-e3a6-407a-ae80-5c31d33fdacc</TenantId>
</MessageDestinationRepresentation>
<MessageRouteRepresentation>
<CreatedDateUtc>2025-07-17T09:10:54.6034698+00:00</CreatedDateUtc>
<UpdatedDateUtc>2025-07-17T09:10:54.6034698+00:00</UpdatedDateUtc>
<ApplicationId>dc84e851-d5eb-4677-afde-709e6517ceed</ApplicationId>
<ApplicationVersionId>96626490-7496-4cae-8afd-6bebe9c5daa1</ApplicationVersionId>
<Description>sample string 5</Description>
<DeviceGroupId>b8042072-cc10-4b58-b2b3-47cd83954c7b</DeviceGroupId>
<DeviceId>4a06892c-c5dc-4e73-9b27-076f00176b37</DeviceId>
<MessageDestinationId>efec902d-c077-4a15-b907-5c3689d7daeb</MessageDestinationId>
<MessageRouteId>52a83941-18dd-4757-ade2-6544040a1772</MessageRouteId>
<MessageTypeId>122296d5-cb67-493a-adea-2236d6d26a77</MessageTypeId>
<Name>sample string 4</Name>
<TenantId>2dc7db37-1987-4fc6-824c-b75c405b251d</TenantId>
<UserGroupId>9885112a-463e-4441-9342-dd4bdf8c4034</UserGroupId>
<UserId>a731240c-c880-489f-a7c1-f162b104295b</UserId>
</MessageRouteRepresentation>
<TenantId>b07dceb6-13a0-4470-933c-1245b00c2c9c</TenantId>
</MessageRouteDestinationRepresentation>
Sample not available.