Applications

How an application's end user notices are sent

Returns the application's email sender setting. With no setting saved the mode is default (the CustomDomain™ transactional sender). The SMTP password is write only: it is never returned, only password_set. Requires app:read.

get/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

Response

The setting.

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.