Applications

Set how an application's end user notices are sent

Replaces the setting. mode is default (the CustomDomain™ sender), smtp (the platform's own mail server, with the notice's From taken from from_address and from_name) or none (nothing is sent; use the connection.records_outdated webhook instead). With smtp, the host must be a public address, the port one of 25, 465, 587 or 2525, and TLS is always on: implicit on 465, starttls on the others. Plain text is not offered. The password is sealed at rest; leave smtp_password out to keep the stored one. A change of server, login or sender clears verified_at. A mail failure at send time falls back to the default sender for that message and is recorded in last_error. Requires app:write.

put/applications/{id}/email-sender

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/applications/{id}/email-sender
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

mode'default' | 'smtp' | 'none' required
smtp_hoststring

A public host name or address. Private

smtp_port25 | 465 | 587 | 2525
smtp_usernamestring
smtp_passwordstring

Write only. Omit to keep the stored password.

tls'implicit' | 'starttls'

implicit on port 465

from_addressstring

A plain address such as hello@example.com. Required for smtp.

from_namestring
reply_tostring

Response

Saved.

application_idstring required
mode'default' | 'smtp' | 'none' required
smtp_hoststring required
smtp_portinteger required
smtp_usernamestring required
password_setboolean required

Whether a password is stored. The password itself is never returned.

tls'implicit' | 'starttls' required
from_addressstring required
from_namestring required
reply_tostring required
verified_atstring date-time nullable required
last_errorstring required

The last failure

last_error_atstring date-time nullable required
updated_atstring date-time nullable

Changes

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