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": "54c689da-7983-4b19-b074-5fc733d58e8a",
"messageRouteRepresentation": {
"messageRouteId": "e0eeae0d-cd91-4cf4-89b2-100d16e5b211",
"tenantId": "62107f38-8ce1-4e0b-9bb6-fe24b84d730b",
"messageTypeId": "2f4fc9f8-0e6b-4890-887a-03973d1468cf",
"userId": "03f78c78-beeb-4c47-bb03-bb91490d1d89",
"userGroupId": "1b466795-f5fb-4a78-bcba-67d343ec8970",
"deviceId": "10e90d75-c88d-4d17-8851-05abed19e16d",
"deviceGroupId": "a0685008-f131-4b3c-8dc3-2f49d743d1f9",
"applicationId": "e043de05-9bd5-4e70-a0d7-900930228c47",
"applicationVersionId": "cdb40afc-4699-486b-9b80-7e3cd5dc3edf",
"messageDestinationId": "a27a57b4-80e0-4899-8f74-d27bd19f5f48",
"name": "sample string 4",
"description": "sample string 5",
"createdDateUtc": "2026-09-05T16:03:41.2343418+00:00",
"updatedDateUtc": "2026-09-05T16:03:41.2343418+00:00"
},
"messageDestinationRepresentation": {
"messageDestinationId": "83d7ce9c-c995-4a78-8f9b-7053ed97847a",
"messageDestinationTypeId": "9551906b-6091-4bd6-894c-8083f992ac87",
"tenantId": "1a370c30-a806-4e78-a861-ad3de3513c27",
"name": "sample string 4",
"description": "sample string 5",
"address": "sample string 6",
"createdDateUtc": "2026-09-05T16:03:41.2343418+00:00",
"updatedDateUtc": "2026-09-05T16:03:41.2343418+00:00"
},
"createdDateUtc": "2026-09-05T16:03:41.2343418+00:00",
"updatedDateUtc": "2026-09-05T16:03:41.2343418+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-05T16:03:41.2343418+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-05T16:03:41.2343418+00:00</UpdatedDateUtc>
<MessageDestinationRepresentation>
<CreatedDateUtc>2026-09-05T16:03:41.2343418+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-05T16:03:41.2343418+00:00</UpdatedDateUtc>
<Address>sample string 6</Address>
<Description>sample string 5</Description>
<MessageDestinationId>83d7ce9c-c995-4a78-8f9b-7053ed97847a</MessageDestinationId>
<MessageDestinationTypeId>9551906b-6091-4bd6-894c-8083f992ac87</MessageDestinationTypeId>
<Name>sample string 4</Name>
<TenantId>1a370c30-a806-4e78-a861-ad3de3513c27</TenantId>
</MessageDestinationRepresentation>
<MessageRouteRepresentation>
<CreatedDateUtc>2026-09-05T16:03:41.2343418+00:00</CreatedDateUtc>
<UpdatedDateUtc>2026-09-05T16:03:41.2343418+00:00</UpdatedDateUtc>
<ApplicationId>e043de05-9bd5-4e70-a0d7-900930228c47</ApplicationId>
<ApplicationVersionId>cdb40afc-4699-486b-9b80-7e3cd5dc3edf</ApplicationVersionId>
<Description>sample string 5</Description>
<DeviceGroupId>a0685008-f131-4b3c-8dc3-2f49d743d1f9</DeviceGroupId>
<DeviceId>10e90d75-c88d-4d17-8851-05abed19e16d</DeviceId>
<MessageDestinationId>a27a57b4-80e0-4899-8f74-d27bd19f5f48</MessageDestinationId>
<MessageRouteId>e0eeae0d-cd91-4cf4-89b2-100d16e5b211</MessageRouteId>
<MessageTypeId>2f4fc9f8-0e6b-4890-887a-03973d1468cf</MessageTypeId>
<Name>sample string 4</Name>
<TenantId>62107f38-8ce1-4e0b-9bb6-fe24b84d730b</TenantId>
<UserGroupId>1b466795-f5fb-4a78-bcba-67d343ec8970</UserGroupId>
<UserId>03f78c78-beeb-4c47-bb03-bb91490d1d89</UserId>
</MessageRouteRepresentation>
<TenantId>54c689da-7983-4b19-b074-5fc733d58e8a</TenantId>
</MessageRouteDestinationRepresentation>
Sample not available.