Skip to content
Artist Alley

Update the SMTP configuration

PATCH
/admin/system/smtp

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
host
required
string
Example
smtp.example.com
port
required
integer
Example
587
encryption
required
string
Allowed values: none starttls tls
Example
starttls
username
string
password

Write-only. Provide to set or rotate the SMTP password; omit (or send empty string) on PATCH to keep the current value. The response never echoes this field — read password_set instead to check whether one is on file. Stored at rest encrypted via the AA_MASTER_KEY-backed atrest package; never sent back to clients.

string format: password
password_set

True when a password is currently stored. Set by the server on GET responses; ignored if sent on PATCH.

boolean
from_address
required
string
Example
ArtSite <noreply@example.com>

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Updated SMTP config

object
host
required
string
Example
smtp.example.com
port
required
integer
Example
587
encryption
required
string
Allowed values: none starttls tls
Example
starttls
username
string
password

Write-only. Provide to set or rotate the SMTP password; omit (or send empty string) on PATCH to keep the current value. The response never echoes this field — read password_set instead to check whether one is on file. Stored at rest encrypted via the AA_MASTER_KEY-backed atrest package; never sent back to clients.

string format: password
password_set

True when a password is currently stored. Set by the server on GET responses; ignored if sent on PATCH.

boolean
from_address
required
string
Example
ArtSite <noreply@example.com>

400

Section titled “400 ”

Malformed request

object
error
required

Human-readable error summary

string
Example
the request could not be completed

401

Section titled “401 ”

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

403

Section titled “403 ”

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed