v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB

Domains

Update a route

Updates the destination of the route bound to <address>@<domain>. The address itself is the resource identity and cannot be changed; delete and recreate the route to rename it.

patch/v1/domains/{domain}/routes/{address}

Path parameters

domainstring required

addressstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

agentIdstring

Agent identifier; required when type is agent, ignored when type is webhook.

type'agent' | 'webhook'

dataobject

Replaces route metadata when provided (max 10 keys, 500 characters total for keys+values).

Response

_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).