Admin > SMTP configuration

Update SMTP configuration

Create or replace the SMTP configuration used by your self-hosted tenant to send email. This endpoint is accessible only to self-hosted customers. The request replaces the full configuration rather than updating individual fields, so include every value you want to keep. Because the password is never returned, it must be included whenever the configuration uses SMTP authentication.

patch/api/v1/admin/smtp

Request

  • Base URL: https://your-tenant.tines.com
  • URL: https://your-tenant.tines.com/api/v1/admin/smtp
  • Auth: one of:
    • API key in header X-User-Token
    • HTTP bearer

Request body

addressstring required

SMTP server address. Maximum length: 255 characters

portinteger required

SMTP server port. Must be an integer from 1 to 65535

domainstring

Domain sent during the SMTP greeting. Maximum length: 255 characters

user_namestring

User name used for SMTP authentication. Required when auth_type is set. Maximum length: 255 characters

passwordstring

Password used for SMTP authentication. Required when auth_type is set. Maximum length: 1024 characters

auth_type'plain' | 'login' | 'cram_md5'

Authentication mode. When omitted, Tines does not authenticate to the SMTP server

encryption_mode'none' | 'tls' | 'starttls_auto' | 'starttls_strict' required

Encryption mode used to secure the SMTP connection

verify_ssl_certificateboolean required

Whether the SMTP server's TLS certificate is verified

ca_pathstring

Path to a directory of CA certificates on the self-hosted installation. Maximum length: 4096 characters

ca_filestring

Path to a CA certificate file on the self-hosted installation. Takes precedence over ca_path. Maximum length: 4096 characters

open_timeoutinteger

SMTP connection open timeout in seconds. An integer from 1 to 120

read_timeoutinteger

SMTP connection read timeout in seconds. An integer from 1 to 120

Response

Empty response on success, or an object describing configuration warnings when the saved configuration has warnings

warningsobject nullable

Configuration warnings keyed by field

Changes

No recorded changes to this operation across all 1 revision of this API.