v4

latestOpenAPI 3.0.0MIT2026-07-311554531.6 MB

Domains

Test an inbound route

Sends a synthetic inbound email through the same delivery path as production (outbound webhooks for webhook routes, signed HTTP to the agent for agent routes). Use dryRun: true to preview the payload without delivering.

post/v1/domains/{domain}/routes/{address}/test

Path parameters

domainstring required

addressstring required

Request body

subjectstring required

textstring

htmlstring

dryRunboolean

When true, returns the payload that would be delivered without invoking outbound webhooks or the agent HTTP endpoint.

Response

matchedboolean required

dryRunboolean required

domainStatus'pending' | 'verified'

mxRecordConfiguredboolean

type'agent' | 'webhook'

wouldDeliverTostring

Human-readable delivery target summary in dry-run mode.

payloadobject

The outbound payload (dry-run only).