v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
Routes

Simulate routing for a recipient

Resolves where an inbound email to recipient would be delivered, with a trace of every rule evaluated and why. Read-only; creates nothing.

post/routes/simulate

Headers

Idempotency-Keystring

Optional client-supplied idempotency key. Retrying a request with the same key returns the original result instead of performing the action a second time; if omitted the server derives one from the canonical payload hash. Safe to retry network failures without duplicating side effects.

Request body

recipientstring required
event_typestring

Event type to model; defaults to email.received.

Response

Routing decision

successtrue required