v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Domains

Create a route

Creates a route on the domain that forwards inbound mail addressed to <address>@<domain> to either a webhook or an agent. Each address on a domain may only have a single route.

post/v1/domains/{domain}/routes

Path parameters

domainstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

addressstring required

Inbox address local part (e.g. "support", "*")

agentIdstring

Agent identifier; required when type is agent, unused for webhook

type'agent' | 'webhook' required

dataobject

Optional string key-value metadata (max 10 keys, 500 characters total for keys+values).

Response

Created

_idstring required

_domainIdstring required

addressstring required

agentIdstring

Internal id of the destination agent. Only present for agent routes.

type'agent' | 'webhook' required

_environmentIdstring required

_organizationIdstring required

createdAtstring required

updatedAtstring required

dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).