v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB

Routes

Update a route

Partial update supported.

put/routes/{id}

Headers

X-Client-IDinteger

Switch client context (multi-tenant).

Request body

provider_idinteger required

Must exist in providers table.

route_namestring required

hoststring required

SMTP hostname or full HTTP URL.

portinteger

SMTP port (not used for HTTP).

usernamestring

SMTP username.

passwordstring password

AES-256 encrypted at rest.

api_keystring

HTTP provider API key; AES-256 encrypted at rest.

status'active' | 'inactive'

protocol_type'smtp' | 'http'

worker_sizeinteger

buffer_sizeinteger

is_defaultboolean

Only one default per client.

tls_mode'starttls' | 'tls' | 'none'

Response

Route updated.

idinteger

provider_idinteger

route_namestring

hoststring

portinteger

SMTP port; null for HTTP routes.

usernamestring

SMTP username (masked on read).

passwordstring

Masked value.

api_keystring

Masked value.

status'active' | 'inactive'

protocol_type'smtp' | 'http'

worker_sizeinteger

buffer_sizeinteger

is_defaultboolean

tls_mode'starttls' | 'tls' | 'none'

created_atstring date-time