Skip to content

route.md

Latest commit

 

History

History
35 lines (25 loc) · 1.15 KB

route.md

File metadata and controls

35 lines (25 loc) · 1.15 KB
Raw

route

Route a message to one of your registered routes (by routeId or address), running that route's action — agent, webhook, or forward. The route must already exist on your account; arbitrary destinations are not allowed.

HTTP: POST /v1/route

Parameters

Field Type Required Description
routeId string Target route by id (rte_…). One of routeId or address is required. The route must already…
address string Target route by the address it matches. One of routeId or address is required.
from string ✓ Sender address recorded on the message.
subject string Optional subject line.
text string Plain-text body.
html string HTML body.

Returns

route-response — see the route-response schema.

Example

res = mk.route({
    "routeId": "rte_1",
    "from": "ops@example.com",
    "subject": "Process this",
    "text": "Please handle.",
})

← All methods · Docs · mailkite.dev