Save email settings

PUT

/api/v1/instance/email

curl --request PUT \
  --url https://example.com/api/v1/instance/email \
  --header 'Content-Type: application/json' \
  --header 'X-CSRF-Token: <X-CSRF-Token>' \
  --cookie ttx_access_token=<ttx_access_token> \
  --data '{ "enabled": true, "from_address": "example", "from_name": "example", "reply_to": "example", "smtp_host": "example", "smtp_password": "example", "smtp_port": 587, "smtp_security": "starttls", "smtp_username": "example" }'

Recorded (without the password), with step-up: whoever controls the mail server reads every message the deployment sends.

Authorizations

• csrfToken
• sessionCookie

Request Body^required

Media typeapplication/json

EmailSettingsUpdateRequest

object

enabled

Enabled

boolean

default: true

from_address

required

From Address

string

>= 3 characters <= 320 characters

from_name

Any of:

string

string

<= 120 characters

null

null

reply_to

Any of:

string

string

<= 320 characters

null

null

smtp_host

required

Smtp Host

string

>= 1 characters <= 253 characters

smtp_password

Any of:

string

string

<= 1000 characters

null

null

smtp_port

Smtp Port

integer

default: 587 >= 1 <= 65535

smtp_security

Smtp Security

string

default: starttls

Allowed values: starttls tls none

smtp_username

Any of:

string

string

<= 320 characters

null

null

Responses

200

Successful Response

Media typeapplication/json

EmailSettingsRead

Platform -> Email. Never carries a secret: has_password says whether one is stored, password_readable whether the current key still decrypts it.

object

active

required

Active

boolean

allow_insecure

required

Allow Insecure

boolean

configured

required

Configured

boolean

enabled

Enabled

boolean

failed

Failed

integer

0

from_address

Any of:

string

string

null

null

from_name

Any of:

string

string

null

null

has_password

Has Password

boolean

last_error

Any of:

string

string

null

null

last_failed_at

Any of:

string

string format: date-time

null

null

last_sent_at

Any of:

string

string format: date-time

null

null

password_readable

Password Readable

boolean

default: true

pending

Pending

integer

0

pinned_by_env

required

Pinned By Env

boolean

reply_to

Any of:

string

string

null

null

smtp_host

Any of:

string

string

null

null

smtp_port

Any of:

integer

integer

null

null

smtp_security

Any of:

string

string

Allowed values: starttls tls none

null

null

smtp_username

Any of:

string

string

null

null

transport

Any of:

string

string

null

null

updated_at

Any of:

string

string format: date-time

null

null

Example

{
  "enabled": false,
  "failed": 0,
  "has_password": false,
  "password_readable": true,
  "pending": 0,
  "smtp_security": "starttls"
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

ctx

Context

object

input

Input

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}