v2

latestOpenAPI 3.1.0Proprietary2026-07-26127193620.1 KB
Routes

Create a recipient route

Binds a recipient pattern to a destination. Provide exactly one of endpoint_id (an existing endpoint) or function_id. With function_id, a dedicated route-target endpoint is minted for that function in the same transaction, enabling per-address function routing (e.g. alice@acme.com -> functionA).

post/routes

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

match_type'exact' | 'wildcard' | 'regex' required
patternstring required
endpoint_idstring uuid

An existing endpoint to route to. Mutually exclusive with function_id.

function_idstring uuid

Route to this function, minting its route-target endpoint if needed. Mutually exclusive with endpoint_id.

domain_idstring uuid nullable

Scope the route to a domain; defaults to the pattern's domain.

priorityinteger
enabledboolean

Response

Route created

successtrue required