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": "afa4896a-51a4-4d43-942a-bf75abb8720a",
"messageRouteRepresentation": {
"messageRouteId": "7b965b23-557c-4c41-8c8a-357a361e83ee",
"tenantId": "b3e6e8a8-554c-467b-9a28-8dd5b4f2a05f",
"messageTypeId": "58b0f3c0-7bed-4adc-a920-b6b07e7c1ce5",
"userId": "faf976ef-0a20-4132-90b7-4610a9841775",
"userGroupId": "a061dd20-3064-4194-8da3-68714d4f9d19",
"deviceId": "7f2f24c6-5502-4335-8e8d-4902ad397e91",
"deviceGroupId": "1267fc7b-8961-42f9-87a1-4c2b79e0b3b6",
"applicationId": "09e98aa2-1370-4096-bffd-0156c7e8ee96",
"applicationVersionId": "90c96bfc-5d56-4a79-afd5-4d744edd8f8c",
"messageDestinationId": "da7f1708-79d4-4a81-9ce5-65c44020f6ab",
"name": "sample string 4",
"description": "sample string 5",
"createdDateUtc": "2026-09-10T19:05:23.5741085+00:00",
"updatedDateUtc": "2026-09-10T19:05:23.5741085+00:00"
},
"messageDestinationRepresentation": {
"messageDestinationId": "02083e87-29ac-4f5e-96c2-7b2a681f5cda",
"messageDestinationTypeId": "baac7f58-a72c-4810-8ae8-1f0d11c59f02",
"tenantId": "1077f640-0490-4994-aa20-9ec4039e5901",
"name": "sample string 4",
"description": "sample string 5",
"address": "sample string 6",
"createdDateUtc": "2026-09-10T19:05:23.5741085+00:00",
"updatedDateUtc": "2026-09-10T19:05:23.5741085+00:00"
},
"createdDateUtc": "2026-09-10T19:05:23.5741085+00:00",
"updatedDateUtc": "2026-09-10T19:05:23.5741085+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>2026-09-10T19:05:23.5741085+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-10T19:05:23.5741085+00:00</UpdatedDateUtc>
<MessageDestinationRepresentation>
<CreatedDateUtc>2026-09-10T19:05:23.5741085+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-10T19:05:23.5741085+00:00</UpdatedDateUtc>
<Address>sample string 6</Address>
<Description>sample string 5</Description>
<MessageDestinationId>02083e87-29ac-4f5e-96c2-7b2a681f5cda</MessageDestinationId>
<MessageDestinationTypeId>baac7f58-a72c-4810-8ae8-1f0d11c59f02</MessageDestinationTypeId>
<Name>sample string 4</Name>
<TenantId>1077f640-0490-4994-aa20-9ec4039e5901</TenantId>
</MessageDestinationRepresentation>
<MessageRouteRepresentation>
<CreatedDateUtc>2026-09-10T19:05:23.5741085+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-10T19:05:23.5741085+00:00</UpdatedDateUtc>
<ApplicationId>09e98aa2-1370-4096-bffd-0156c7e8ee96</ApplicationId>
<ApplicationVersionId>90c96bfc-5d56-4a79-afd5-4d744edd8f8c</ApplicationVersionId>
<Description>sample string 5</Description>
<DeviceGroupId>1267fc7b-8961-42f9-87a1-4c2b79e0b3b6</DeviceGroupId>
<DeviceId>7f2f24c6-5502-4335-8e8d-4902ad397e91</DeviceId>
<MessageDestinationId>da7f1708-79d4-4a81-9ce5-65c44020f6ab</MessageDestinationId>
<MessageRouteId>7b965b23-557c-4c41-8c8a-357a361e83ee</MessageRouteId>
<MessageTypeId>58b0f3c0-7bed-4adc-a920-b6b07e7c1ce5</MessageTypeId>
<Name>sample string 4</Name>
<TenantId>b3e6e8a8-554c-467b-9a28-8dd5b4f2a05f</TenantId>
<UserGroupId>a061dd20-3064-4194-8da3-68714d4f9d19</UserGroupId>
<UserId>faf976ef-0a20-4132-90b7-4610a9841775</UserId>
</MessageRouteRepresentation>
<TenantId>afa4896a-51a4-4d43-942a-bf75abb8720a</TenantId>
</MessageRouteDestinationRepresentation>
Sample not available.