Skip to navigation
REST APINotificationsEmail

Validate configuration of Email Channel

View as Markdown
Validate configuration of Email Channel

Authentication

AuthorizationBearer
Bearer authentication

Request

This endpoint expects an object.
smtpHoststringRequired<=250 characters
usernamestringOptional<=250 characters
passwordstringOptional<=250 characters
fromstringOptional<=250 characters
smtpPortintegerOptional<=65535Defaults to 587
authTypeenumOptionalDefaults to auth_login
Allowed values:
smtpTlsEnabledboolean or nullOptional
recipientslist of stringsOptionalDefaults to []
fromDisplayNamestringOptional<=250 charactersDefaults to Run:ai
directNotificationsboolean or nullOptional
useAttachmentsboolean or nullOptional
subjectstringOptional<=250 charactersDefaults to Run:ai notification - {{ .category }} {{ .reason }}

Response

Email Channel validity
statusboolean
messagestringOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error
501
Not Implemented Error
503
Service Unavailable Error