Interface CreateInboundRouteRequest

Request body for POST /v2/tenants/{slug}/inbound-routes.

interface CreateInboundRouteRequest {
    domainName: string;
    mtaListenerId: string;
    onboardDomainIfMissing?: boolean;
}

Properties

domainName: string

The routed recipient domain.

mtaListenerId: string

The MTA listener that receives the mail.

onboardDomainIfMissing?: boolean

When true, onboard an unclaimed inbound-only domain before creating the route.